Class: Google::Apis::SheetsV4::DeveloperMetadataLookup

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

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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ DeveloperMetadataLookup

Returns a new instance of DeveloperMetadataLookup



4152
4153
4154
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4152

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

Returns:

  • (String) 


4103
4104
4105
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4103

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

Returns:

  • (String) 


4120
4121
4122
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4120

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

Returns:

  • (Fixnum) 


4126
4127
4128
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4126

def metadata_id
  @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

Returns:

  • (String) 


4132
4133
4134
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4132

def metadata_key
  @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

Returns:



4137
4138
4139
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4137

def metadata_location
  @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

Returns:

  • (String) 


4143
4144
4145
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4143

def metadata_value
  @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

Returns:

  • (String) 


4150
4151
4152
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4150

def visibility
  @visibility
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4157
4158
4159
4160
4161
4162
4163
4164
4165
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4157

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