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.


1462
1463
1464
# File 'generated/google/apis/drive_v2/classes.rb', line 1462

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


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

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)

1407
1408
1409
# File 'generated/google/apis/drive_v2/classes.rb', line 1407

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


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

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)

1418
1419
1420
# File 'generated/google/apis/drive_v2/classes.rb', line 1418

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)

1423
1424
1425
# File 'generated/google/apis/drive_v2/classes.rb', line 1423

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)

1428
1429
1430
# File 'generated/google/apis/drive_v2/classes.rb', line 1428

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)

1435
1436
1437
# File 'generated/google/apis/drive_v2/classes.rb', line 1435

def id
  @id
end

#kindString

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

Returns:

  • (String)

1440
1441
1442
# File 'generated/google/apis/drive_v2/classes.rb', line 1440

def kind
  @kind
end

#nameString

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

Returns:

  • (String)

1445
1446
1447
# File 'generated/google/apis/drive_v2/classes.rb', line 1445

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


1451
1452
1453
# File 'generated/google/apis/drive_v2/classes.rb', line 1451

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)

1460
1461
1462
# File 'generated/google/apis/drive_v2/classes.rb', line 1460

def theme_id
  @theme_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
# File 'generated/google/apis/drive_v2/classes.rb', line 1467

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