Class: Google::Apis::DriveV3::Drive

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

Overview

Representation of a shared drive.

Defined Under Namespace

Classes: BackgroundImageFile, Capabilities, Restrictions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Drive

Returns a new instance of Drive.



700
701
702
 
# File 'generated/google/apis/drive_v3/classes.rb', line 700

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

Instance Attribute Details

#background_image_file ⇒ Google::Apis::DriveV3::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

Returns:



639
640
641
 
# File 'generated/google/apis/drive_v3/classes.rb', line 639

def background_image_file
  @background_image_file
end

#background_image_link ⇒ String

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

Returns:

  • (String) 


644
645
646
 
# File 'generated/google/apis/drive_v3/classes.rb', line 644

def background_image_link
  @background_image_link
end

#capabilities ⇒ Google::Apis::DriveV3::Drive::Capabilities

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

Returns:



649
650
651
 
# File 'generated/google/apis/drive_v3/classes.rb', line 649

def capabilities
  @capabilities
end

#color_rgb ⇒ String

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) 


655
656
657
 
# File 'generated/google/apis/drive_v3/classes.rb', line 655

def color_rgb
  @color_rgb
end

#created_time ⇒ DateTime

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

Returns:

  • (DateTime) 


660
661
662
 
# File 'generated/google/apis/drive_v3/classes.rb', line 660

def created_time
  @created_time
end

#hidden ⇒ Boolean Also known as: hidden?

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

Returns:

  • (Boolean) 


665
666
667
 
# File 'generated/google/apis/drive_v3/classes.rb', line 665

def hidden
  @hidden
end

#id ⇒ String

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) 


672
673
674
 
# File 'generated/google/apis/drive_v3/classes.rb', line 672

def id
  @id
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string "drive#drive" . Corresponds to the JSON property kind

Returns:

  • (String) 


678
679
680
 
# File 'generated/google/apis/drive_v3/classes.rb', line 678

def kind
  @kind
end

#name ⇒ String

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

Returns:

  • (String) 


683
684
685
 
# File 'generated/google/apis/drive_v3/classes.rb', line 683

def name
  @name
end

#restrictions ⇒ Google::Apis::DriveV3::Drive::Restrictions

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

Returns:



689
690
691
 
# File 'generated/google/apis/drive_v3/classes.rb', line 689

def restrictions
  @restrictions
end

#theme_id ⇒ String

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.create 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) 


698
699
700
 
# File 'generated/google/apis/drive_v3/classes.rb', line 698

def theme_id
  @theme_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



705
706
707
708
709
710
711
712
713
714
715
716
717
 
# File 'generated/google/apis/drive_v3/classes.rb', line 705

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_time = args[:created_time] if args.key?(:created_time)
  @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