Class: Google::Apis::SheetsV4::DeveloperMetadataLookup
- Inherits:
-
Object
- Object
- Google::Apis::SheetsV4::DeveloperMetadataLookup
- 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
Selects DeveloperMetadata that matches all of the specified fields. For example, if only a metadata ID is specified this considers the DeveloperMetadata with that particular unique ID. If a metadata key is specified, this considers all developer metadata with that key. If a key, visibility, and location type are all specified, this considers all developer metadata with that key and visibility that are associated with a location of that type. In general, this selects all DeveloperMetadata that matches the intersection of all the specified fields; any field or combination of fields may be specified.
Instance Attribute Summary collapse
-
#location_matching_strategy ⇒ String
Determines how this lookup matches the location.
-
#location_type ⇒ String
Limits the selected developer metadata to those entries which are associated with locations of the specified type.
-
#metadata_id ⇒ Fixnum
Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id.
-
#metadata_key ⇒ String
Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key.
-
#metadata_location ⇒ Google::Apis::SheetsV4::DeveloperMetadataLocation
A location where metadata may be associated in a spreadsheet.
-
#metadata_value ⇒ String
Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value.
-
#visibility ⇒ String
Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility.
Instance Method Summary collapse
-
#initialize(**args) ⇒ DeveloperMetadataLookup
constructor
A new instance of DeveloperMetadataLookup.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ DeveloperMetadataLookup
Returns a new instance of DeveloperMetadataLookup.
4787 4788 4789 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 4787 def initialize(**args) update!(**args) end |
Instance Attribute Details
#location_matching_strategy ⇒ String
Determines how this lookup matches the location. If this field is
specified as EXACT, only developer metadata associated on the exact
location specified is matched. If this field is specified to INTERSECTING,
developer metadata associated on intersecting locations is also
matched. If left unspecified, this field assumes a default value of
INTERSECTING.
If this field is specified, a metadataLocation
must also be specified.
Corresponds to the JSON property locationMatchingStrategy
4738 4739 4740 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 4738 def location_matching_strategy @location_matching_strategy end |
#location_type ⇒ String
Limits the selected developer metadata to those entries which are
associated with locations of the specified type. For example, when this
field is specified as ROW this lookup
only considers developer metadata associated on rows. If the field is left
unspecified, all location types are considered. This field cannot be
specified as SPREADSHEET when
the locationMatchingStrategy
is specified as INTERSECTING or when the
metadataLocation is specified as a
non-spreadsheet location: spreadsheet metadata cannot intersect any other
developer metadata location. This field also must be left unspecified when
the locationMatchingStrategy
is specified as EXACT.
Corresponds to the JSON property locationType
4755 4756 4757 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 4755 def location_type @location_type end |
#metadata_id ⇒ Fixnum
Limits the selected developer metadata to that which has a matching
DeveloperMetadata.metadata_id.
Corresponds to the JSON property metadataId
4761 4762 4763 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 4761 def @metadata_id end |
#metadata_key ⇒ String
Limits the selected developer metadata to that which has a matching
DeveloperMetadata.metadata_key.
Corresponds to the JSON property metadataKey
4767 4768 4769 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 4767 def @metadata_key end |
#metadata_location ⇒ Google::Apis::SheetsV4::DeveloperMetadataLocation
A location where metadata may be associated in a spreadsheet.
Corresponds to the JSON property metadataLocation
4772 4773 4774 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 4772 def @metadata_location end |
#metadata_value ⇒ String
Limits the selected developer metadata to that which has a matching
DeveloperMetadata.metadata_value.
Corresponds to the JSON property metadataValue
4778 4779 4780 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 4778 def @metadata_value end |
#visibility ⇒ String
Limits the selected developer metadata to that which has a matching
DeveloperMetadata.visibility. If left unspecified, all developer
metadata visibile to the requesting project is considered.
Corresponds to the JSON property visibility
4785 4786 4787 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 4785 def visibility @visibility end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4792 4793 4794 4795 4796 4797 4798 4799 4800 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 4792 def update!(**args) @location_matching_strategy = args[:location_matching_strategy] if args.key?(:location_matching_strategy) @location_type = args[:location_type] if args.key?(:location_type) @metadata_id = args[:metadata_id] if args.key?(:metadata_id) @metadata_key = args[:metadata_key] if args.key?(:metadata_key) @metadata_location = args[:metadata_location] if args.key?(:metadata_location) @metadata_value = args[:metadata_value] if args.key?(:metadata_value) @visibility = args[:visibility] if args.key?(:visibility) end |