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.



379
380
381
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 379

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:



268
269
270
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 268

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) 


273
274
275
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 273

def create_time
  @create_time
end

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

Information about a user. Corresponds to the JSON property creator

Returns:



278
279
280
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 278

def creator
  @creator
end

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

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

Returns:



283
284
285
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 283

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) 


289
290
291
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 289

def disable_time
  @disable_time
end

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

Information about a user. Corresponds to the JSON property disabler

Returns:



294
295
296
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 294

def disabler
  @disabler
end

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

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

Returns:



299
300
301
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 299

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) 


305
306
307
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 305

def id
  @id
end

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

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

Returns:



310
311
312
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 310

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:



324
325
326
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 324

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:



330
331
332
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 330

def lock_status
  @lock_status
end

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

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

Returns:



335
336
337
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 335

def properties
  @properties
end

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

Information about a user. Corresponds to the JSON property publisher

Returns:



340
341
342
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 340

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) 


347
348
349
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 347

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:



352
353
354
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 352

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:



357
358
359
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 357

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:



362
363
364
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 362

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) 


367
368
369
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 367

def update_time
  @update_time
end

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

Information about a user. Corresponds to the JSON property updater

Returns:



372
373
374
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 372

def updater
  @updater
end

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

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

Returns:



377
378
379
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 377

def user_options
  @user_options
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/google/apis/drivelabels_v2/classes.rb', line 384

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