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

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.



651
652
653
 
# File 'generated/google/apis/drive_v3/classes.rb', line 651

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:



590
591
592
 
# File 'generated/google/apis/drive_v3/classes.rb', line 590

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) 


595
596
597
 
# File 'generated/google/apis/drive_v3/classes.rb', line 595

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:



600
601
602
 
# File 'generated/google/apis/drive_v3/classes.rb', line 600

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) 


606
607
608
 
# File 'generated/google/apis/drive_v3/classes.rb', line 606

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) 


611
612
613
 
# File 'generated/google/apis/drive_v3/classes.rb', line 611

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) 


616
617
618
 
# File 'generated/google/apis/drive_v3/classes.rb', line 616

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) 


623
624
625
 
# File 'generated/google/apis/drive_v3/classes.rb', line 623

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) 


629
630
631
 
# File 'generated/google/apis/drive_v3/classes.rb', line 629

def kind
  @kind
end

#name ⇒ String

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

Returns:

  • (String) 


634
635
636
 
# File 'generated/google/apis/drive_v3/classes.rb', line 634

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:



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

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) 


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

def theme_id
  @theme_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



656
657
658
659
660
661
662
663
664
665
666
667
668
 
# File 'generated/google/apis/drive_v3/classes.rb', line 656

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