Class: Google::Apis::SheetsV4::UpdateDeveloperMetadataRequest

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

A request to update properties of developer metadata. Updates the properties of the developer metadata selected by the filters to the values provided in the DeveloperMetadata resource. Callers must specify the properties they wish to update in the fields parameter, as well as specify at least one DataFilter matching the metadata they wish to update.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ UpdateDeveloperMetadataRequest

Returns a new instance of UpdateDeveloperMetadataRequest.



11175
11176
11177
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 11175

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

Instance Attribute Details

#data_filters ⇒ Array<Google::Apis::SheetsV4::DataFilter>

The filters matching the developer metadata entries to update. Corresponds to the JSON property dataFilters

Returns:



11152
11153
11154
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 11152

def data_filters
  @data_filters
end

#developer_metadata ⇒ Google::Apis::SheetsV4::DeveloperMetadata

Developer metadata associated with a location or object in a spreadsheet. For more information, see Read, write, and search metadata. Developer metadata may be used to associate arbitrary data with various parts of a spreadsheet and it 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 is still associated with the row it was first associated with (what is now row 6). If the associated object is deleted then its metadata is deleted too. Corresponds to the JSON property developerMetadata

Returns:



11166
11167
11168
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 11166

def developer_metadata
  @developer_metadata
end

#fields ⇒ String

The fields that should be updated. At least one field must be specified. The root developerMetadata is implied and should not be specified. A single "*" can be used as short-hand for listing every field. Corresponds to the JSON property fields

Returns:



11173
11174
11175
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 11173

def fields
  @fields
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11180
11181
11182
11183
11184
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 11180

def update!(**args)
  @data_filters = args[:data_filters] if args.key?(:data_filters)
  @developer_metadata = args[:developer_metadata] if args.key?(:developer_metadata)
  @fields = args[:fields] if args.key?(:fields)
end