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

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

Overview

Representation of a shared drive. Some resource methods (such as drives. update) require a driveId. Use the drives.list method to retrieve the ID for 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.



1135
1136
1137
 
# File 'lib/google/apis/drive_v3/classes.rb', line 1135

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:



1064
1065
1066
 
# File 'lib/google/apis/drive_v3/classes.rb', line 1064

def background_image_file
  @background_image_file
end

#background_image_link ⇒ String

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

Returns:

  • (String) 


1069
1070
1071
 
# File 'lib/google/apis/drive_v3/classes.rb', line 1069

def background_image_link
  @background_image_link
end

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

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

Returns:



1074
1075
1076
 
# File 'lib/google/apis/drive_v3/classes.rb', line 1074

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) 


1080
1081
1082
 
# File 'lib/google/apis/drive_v3/classes.rb', line 1080

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) 


1085
1086
1087
 
# File 'lib/google/apis/drive_v3/classes.rb', line 1085

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) 


1090
1091
1092
 
# File 'lib/google/apis/drive_v3/classes.rb', line 1090

def hidden
  @hidden
end

#id ⇒ String

Output only. 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) 


1097
1098
1099
 
# File 'lib/google/apis/drive_v3/classes.rb', line 1097

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


1103
1104
1105
 
# File 'lib/google/apis/drive_v3/classes.rb', line 1103

def kind
  @kind
end

#name ⇒ String

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

Returns:

  • (String) 


1108
1109
1110
 
# File 'lib/google/apis/drive_v3/classes.rb', line 1108

def name
  @name
end

#org_unit_id ⇒ String

Output only. The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true. Corresponds to the JSON property orgUnitId

Returns:

  • (String) 


1115
1116
1117
 
# File 'lib/google/apis/drive_v3/classes.rb', line 1115

def org_unit_id
  @org_unit_id
end

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

A set of restrictions that apply to this shared drive or items inside this shared drive. Note that restrictions can't be set when creating a shared drive. To add a restriction, first create a shared drive and then use drives.update to add restrictions. Corresponds to the JSON property restrictions

Returns:



1123
1124
1125
 
# File 'lib/google/apis/drive_v3/classes.rb', line 1123

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) 


1133
1134
1135
 
# File 'lib/google/apis/drive_v3/classes.rb', line 1133

def theme_id
  @theme_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'lib/google/apis/drive_v3/classes.rb', line 1140

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)
  @org_unit_id = args[:org_unit_id] if args.key?(:org_unit_id)
  @restrictions = args[:restrictions] if args.key?(:restrictions)
  @theme_id = args[:theme_id] if args.key?(:theme_id)
end