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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/sheets_v4/classes.rb,
generated/google/apis/sheets_v4/representations.rb,
generated/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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ UpdateDeveloperMetadataRequest

Returns a new instance of UpdateDeveloperMetadataRequest



7988
7989
7990
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7988

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:



7967
7968
7969
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7967

def data_filters
  @data_filters
end

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

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 will be deleted too. Corresponds to the JSON property developerMetadata

Returns:



7979
7980
7981
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7979

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:

  • (String) 


7986
7987
7988
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7986

def fields
  @fields
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7993
7994
7995
7996
7997
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 7993

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