Class: Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2Field

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

Overview

Defines a field that has a display name, data type, and other configuration options. This field defines the kind of metadata that may be set on a Drive item.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAppsDriveLabelsV2Field

Returns a new instance of GoogleAppsDriveLabelsV2Field.



1417
1418
1419
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1417

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

Instance Attribute Details

#applied_capabilities ⇒ Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2FieldAppliedCapabilities

The capabilities related to this field on applied metadata. Corresponds to the JSON property appliedCapabilities

Returns:



1306
1307
1308
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1306

def applied_capabilities
  @applied_capabilities
end

#create_time ⇒ String

Output only. The time this field was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


1311
1312
1313
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1311

def create_time
  @create_time
end

#creator ⇒ Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2UserInfo

Information about a user. Corresponds to the JSON property creator

Returns:



1316
1317
1318
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1316

def creator
  @creator
end

#date_options ⇒ Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2FieldDateOptions

Options for the date field type. Corresponds to the JSON property dateOptions

Returns:



1321
1322
1323
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1321

def date_options
  @date_options
end

#disable_time ⇒ String

Output only. The time this field was disabled. This value has no meaning when the field is not disabled. Corresponds to the JSON property disableTime

Returns:

  • (String) 


1327
1328
1329
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1327

def disable_time
  @disable_time
end

#disabler ⇒ Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2UserInfo

Information about a user. Corresponds to the JSON property disabler

Returns:



1332
1333
1334
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1332

def disabler
  @disabler
end

#display_hints ⇒ Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2FieldDisplayHints

UI display hints for rendering a field. Corresponds to the JSON property displayHints

Returns:



1337
1338
1339
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1337

def display_hints
  @display_hints
end

#id ⇒ String

Output only. The key of a field, unique within a label or library. This value is autogenerated. Matches the regex: ([a-zA-Z0-9])+ Corresponds to the JSON property id

Returns:

  • (String) 


1343
1344
1345
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1343

def id
  @id
end

#integer_options ⇒ Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2FieldIntegerOptions

Options for the Integer field type. Corresponds to the JSON property integerOptions

Returns:



1348
1349
1350
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1348

def integer_options
  @integer_options
end

#lifecycle ⇒ Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2Lifecycle

The lifecycle state of an object, such as label, field, or choice. The lifecycle enforces the following transitions: * UNPUBLISHED_DRAFT (starting state) * UNPUBLISHED_DRAFT -> PUBLISHED * UNPUBLISHED_DRAFT -> (Deleted)

  • PUBLISHED -> DISABLED * DISABLED -> PUBLISHED * DISABLED -> ( Deleted) The published and disabled states have some distinct characteristics:
  • Published—Some kinds of changes might be made to an object in this state, in which case has_unpublished_changes will be true. Also, some kinds of changes are not permitted. Generally, any change that would invalidate or cause new restrictions on existing metadata related to the label are rejected. * Disabled—When disabled, the configured DisabledPolicy takes effect. Corresponds to the JSON property lifecycle

Returns:



1362
1363
1364
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1362

def lifecycle
  @lifecycle
end

#lock_status ⇒ Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2LockStatus

Contains information about whether a label component should be considered locked. Corresponds to the JSON property lockStatus

Returns:



1368
1369
1370
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1368

def lock_status
  @lock_status
end

#properties ⇒ Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2FieldProperties

The basic properties of the field. Corresponds to the JSON property properties

Returns:



1373
1374
1375
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1373

def properties
  @properties
end

#publisher ⇒ Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2UserInfo

Information about a user. Corresponds to the JSON property publisher

Returns:



1378
1379
1380
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1378

def publisher
  @publisher
end

#query_key ⇒ String

Output only. The key to use when constructing Drive search queries to find files based on values defined for this field on files. For example, " query_key > 2001-01-01". Corresponds to the JSON property queryKey

Returns:

  • (String) 


1385
1386
1387
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1385

def query_key
  @query_key
end

#schema_capabilities ⇒ Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2FieldSchemaCapabilities

The capabilities related to this field when editing the field. Corresponds to the JSON property schemaCapabilities

Returns:



1390
1391
1392
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1390

def schema_capabilities
  @schema_capabilities
end

#selection_options ⇒ Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2FieldSelectionOptions

Options for the selection field type. Corresponds to the JSON property selectionOptions

Returns:



1395
1396
1397
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1395

def selection_options
  @selection_options
end

#text_options ⇒ Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2FieldTextOptions

Options for the Text field type. Corresponds to the JSON property textOptions

Returns:



1400
1401
1402
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1400

def text_options
  @text_options
end

#update_time ⇒ String

Output only. The time this field was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1405
1406
1407
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1405

def update_time
  @update_time
end

#updater ⇒ Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2UserInfo

Information about a user. Corresponds to the JSON property updater

Returns:



1410
1411
1412
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1410

def updater
  @updater
end

#user_options ⇒ Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2FieldUserOptions

Options for the user field type. Corresponds to the JSON property userOptions

Returns:



1415
1416
1417
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1415

def user_options
  @user_options
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 1422

def update!(**args)
  @applied_capabilities = args[:applied_capabilities] if args.key?(:applied_capabilities)
  @create_time = args[:create_time] if args.key?(:create_time)
  @creator = args[:creator] if args.key?(:creator)
  @date_options = args[:date_options] if args.key?(:date_options)
  @disable_time = args[:disable_time] if args.key?(:disable_time)
  @disabler = args[:disabler] if args.key?(:disabler)
  @display_hints = args[:display_hints] if args.key?(:display_hints)
  @id = args[:id] if args.key?(:id)
  @integer_options = args[:integer_options] if args.key?(:integer_options)
  @lifecycle = args[:lifecycle] if args.key?(:lifecycle)
  @lock_status = args[:lock_status] if args.key?(:lock_status)
  @properties = args[:properties] if args.key?(:properties)
  @publisher = args[:publisher] if args.key?(:publisher)
  @query_key = args[:query_key] if args.key?(:query_key)
  @schema_capabilities = args[:schema_capabilities] if args.key?(:schema_capabilities)
  @selection_options = args[:selection_options] if args.key?(:selection_options)
  @text_options = args[:text_options] if args.key?(:text_options)
  @update_time = args[:update_time] if args.key?(:update_time)
  @updater = args[:updater] if args.key?(:updater)
  @user_options = args[:user_options] if args.key?(:user_options)
end