Class: Google::Apis::SheetsV4::DeveloperMetadata

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

Overview

Developer metadata associated with a location or object in a spreadsheet. Developer metadata may be used to associate arbitrary data with various parts of a spreadsheet and will remain associated at those locations as they move around and the spreadsheet is edited. For example, if developer metadata is associated with row 5 and another row is then subsequently inserted above row 5, that original metadata will still be associated with the row it was first associated with (what is now row 6). If the associated object is deleted its metadata is deleted too.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DeveloperMetadata

Returns a new instance of DeveloperMetadata.



4806
4807
4808
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 4806

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

Instance Attribute Details

#location ⇒ Google::Apis::SheetsV4::DeveloperMetadataLocation

A location where metadata may be associated in a spreadsheet. Corresponds to the JSON property location

Returns:



4780
4781
4782
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 4780

def location
  @location
end

#metadata_id ⇒ Fixnum

The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when metadata is created, otherwise one will be randomly generated and assigned. Must be positive. Corresponds to the JSON property metadataId

Returns:

  • (Fixnum) 


4787
4788
4789
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 4787

def metadata_id
  @metadata_id
end

#metadata_key ⇒ String

The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer metadata must always have a key specified. Corresponds to the JSON property metadataKey

Returns:

  • (String) 


4793
4794
4795
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 4793

def metadata_key
  @metadata_key
end

#metadata_value ⇒ String

Data associated with the metadata's key. Corresponds to the JSON property metadataValue

Returns:

  • (String) 


4798
4799
4800
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 4798

def metadata_value
  @metadata_value
end

#visibility ⇒ String

The metadata visibility. Developer metadata must always have a visibility specified. Corresponds to the JSON property visibility

Returns:

  • (String) 


4804
4805
4806
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 4804

def visibility
  @visibility
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4811
4812
4813
4814
4815
4816
4817
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 4811

def update!(**args)
  @location = args[:location] if args.key?(:location)
  @metadata_id = args[:metadata_id] if args.key?(:metadata_id)
  @metadata_key = args[:metadata_key] if args.key?(:metadata_key)
  @metadata_value = args[:metadata_value] if args.key?(:metadata_value)
  @visibility = args[:visibility] if args.key?(:visibility)
end