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 will consider the DeveloperMetadata with that particular unique ID. If a metadata key is specified, all developer metadata with that key will be considered. If a key, visibility, and location type are all specified, then all developer metadata with that key, visibility, and associated with a location of that type will be considered. 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



3812
3813
3814
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3812

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 will be matched. If this field is specified to INTERSECTING, developer metadata associated on intersecting locations will also be matched. If left unspecified, this field will assume a default value of INTERSECTING. If this field is specified, a metadataLocation must also be specified. Corresponds to the JSON property locationMatchingStrategy

Returns:

  • (String) 


3762
3763
3764
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3762

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, specifying this as ROW will only consider developer metadata associated on rows. If left unspecified, all location types will be 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) 


3780
3781
3782
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3780

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) 


3786
3787
3788
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3786

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) 


3792
3793
3794
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3792

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:



3797
3798
3799
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3797

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) 


3803
3804
3805
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3803

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 will be considered. Corresponds to the JSON property visibility

Returns:

  • (String) 


3810
3811
3812
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3810

def visibility
  @visibility
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3817
3818
3819
3820
3821
3822
3823
3824
3825
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3817

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