Class: Google::Apis::DriveV2::TeamDrive

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 Team 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) ⇒ TeamDrive

Returns a new instance of TeamDrive



3086
3087
3088
# File 'generated/google/apis/drive_v2/classes.rb', line 3086

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

Instance Attribute Details

#background_image_fileGoogle::Apis::DriveV2::TeamDrive::BackgroundImageFile

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



3031
3032
3033
# File 'generated/google/apis/drive_v2/classes.rb', line 3031

def background_image_file
  @background_image_file
end

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

Returns:

  • (String)


3036
3037
3038
# File 'generated/google/apis/drive_v2/classes.rb', line 3036

def background_image_link
  @background_image_link
end

#capabilitiesGoogle::Apis::DriveV2::TeamDrive::Capabilities

Capabilities the current user has on this Team Drive. Corresponds to the JSON property capabilities



3041
3042
3043
# File 'generated/google/apis/drive_v2/classes.rb', line 3041

def capabilities
  @capabilities
end

#color_rgbString

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

Returns:

  • (String)


3047
3048
3049
# File 'generated/google/apis/drive_v2/classes.rb', line 3047

def color_rgb
  @color_rgb
end

#created_dateDateTime

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

Returns:

  • (DateTime)


3052
3053
3054
# File 'generated/google/apis/drive_v2/classes.rb', line 3052

def created_date
  @created_date
end

#idString

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

Returns:

  • (String)


3058
3059
3060
# File 'generated/google/apis/drive_v2/classes.rb', line 3058

def id
  @id
end

#kindString

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

Returns:

  • (String)


3063
3064
3065
# File 'generated/google/apis/drive_v2/classes.rb', line 3063

def kind
  @kind
end

#nameString

The name of this Team Drive. Corresponds to the JSON property name

Returns:

  • (String)


3068
3069
3070
# File 'generated/google/apis/drive_v2/classes.rb', line 3068

def name
  @name
end

#restrictionsGoogle::Apis::DriveV2::TeamDrive::Restrictions

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



3074
3075
3076
# File 'generated/google/apis/drive_v2/classes.rb', line 3074

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 teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.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)


3084
3085
3086
# File 'generated/google/apis/drive_v2/classes.rb', line 3084

def theme_id
  @theme_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
# File 'generated/google/apis/drive_v2/classes.rb', line 3091

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)
  @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