target.apidocs.com.google.api.services.sheets.v4.model.DeveloperMetadataLookup.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-sheets Show documentation

There is a newer version: v4-rev20240423-2.0.0

Show newest version







DeveloperMetadataLookup (Google Sheets API v4-rev20240312-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.sheets.v4.model
Class DeveloperMetadataLookup



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.sheets.v4.model.DeveloperMetadataLookup













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class DeveloperMetadataLookup
extends com.google.api.client.json.GenericJson
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.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Google Sheets API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


DeveloperMetadataLookup() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


DeveloperMetadataLookup
clone() 


String
getLocationMatchingStrategy()
Determines how this lookup matches the location.



String
getLocationType()
Limits the selected developer metadata to those entries which are associated with locations of
 the specified type.



Integer
getMetadataId()
Limits the selected developer metadata to that which has a matching
 DeveloperMetadata.metadata_id.



String
getMetadataKey()
Limits the selected developer metadata to that which has a matching
 DeveloperMetadata.metadata_key.



DeveloperMetadataLocation
getMetadataLocation()
Limits the selected developer metadata to those entries associated with the specified location.



String
getMetadataValue()
Limits the selected developer metadata to that which has a matching
 DeveloperMetadata.metadata_value.



String
getVisibility()
Limits the selected developer metadata to that which has a matching
 DeveloperMetadata.visibility.



DeveloperMetadataLookup
set(String fieldName,
   Object value) 


DeveloperMetadataLookup
setLocationMatchingStrategy(String locationMatchingStrategy)
Determines how this lookup matches the location.



DeveloperMetadataLookup
setLocationType(String locationType)
Limits the selected developer metadata to those entries which are associated with locations of
 the specified type.



DeveloperMetadataLookup
setMetadataId(Integer metadataId)
Limits the selected developer metadata to that which has a matching
 DeveloperMetadata.metadata_id.



DeveloperMetadataLookup
setMetadataKey(String metadataKey)
Limits the selected developer metadata to that which has a matching
 DeveloperMetadata.metadata_key.



DeveloperMetadataLookup
setMetadataLocation(DeveloperMetadataLocation metadataLocation)
Limits the selected developer metadata to those entries associated with the specified location.



DeveloperMetadataLookup
setMetadataValue(String metadataValue)
Limits the selected developer metadata to that which has a matching
 DeveloperMetadata.metadata_value.



DeveloperMetadataLookup
setVisibility(String visibility)
Limits the selected developer metadata to that which has a matching
 DeveloperMetadata.visibility.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





DeveloperMetadataLookup
public DeveloperMetadataLookup()









Method Detail





getLocationMatchingStrategy
public String getLocationMatchingStrategy()
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.

Returns:
value or null for none








setLocationMatchingStrategy
public DeveloperMetadataLookup setLocationMatchingStrategy(String locationMatchingStrategy)
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.

Parameters:
locationMatchingStrategy - locationMatchingStrategy or null for none








getLocationType
public String getLocationType()
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.

Returns:
value or null for none








setLocationType
public DeveloperMetadataLookup setLocationType(String locationType)
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.

Parameters:
locationType - locationType or null for none








getMetadataId
public Integer getMetadataId()
Limits the selected developer metadata to that which has a matching
 DeveloperMetadata.metadata_id.

Returns:
value or null for none








setMetadataId
public DeveloperMetadataLookup setMetadataId(Integer metadataId)
Limits the selected developer metadata to that which has a matching
 DeveloperMetadata.metadata_id.

Parameters:
metadataId - metadataId or null for none








getMetadataKey
public String getMetadataKey()
Limits the selected developer metadata to that which has a matching
 DeveloperMetadata.metadata_key.

Returns:
value or null for none








setMetadataKey
public DeveloperMetadataLookup setMetadataKey(String metadataKey)
Limits the selected developer metadata to that which has a matching
 DeveloperMetadata.metadata_key.

Parameters:
metadataKey - metadataKey or null for none








getMetadataLocation
public DeveloperMetadataLocation getMetadataLocation()
Limits the selected developer metadata to those entries associated with the specified location.
 This field either matches exact locations or all intersecting locations according the specified
 locationMatchingStrategy.

Returns:
value or null for none








setMetadataLocation
public DeveloperMetadataLookup setMetadataLocation(DeveloperMetadataLocation metadataLocation)
Limits the selected developer metadata to those entries associated with the specified location.
 This field either matches exact locations or all intersecting locations according the specified
 locationMatchingStrategy.

Parameters:
metadataLocation - metadataLocation or null for none








getMetadataValue
public String getMetadataValue()
Limits the selected developer metadata to that which has a matching
 DeveloperMetadata.metadata_value.

Returns:
value or null for none








setMetadataValue
public DeveloperMetadataLookup setMetadataValue(String metadataValue)
Limits the selected developer metadata to that which has a matching
 DeveloperMetadata.metadata_value.

Parameters:
metadataValue - metadataValue or null for none








getVisibility
public String getVisibility()
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.

Returns:
value or null for none








setVisibility
public DeveloperMetadataLookup setVisibility(String visibility)
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.

Parameters:
visibility - visibility or null for none








set
public DeveloperMetadataLookup set(String fieldName,
                                   Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public DeveloperMetadataLookup clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`DeveloperMetadataLookup`	`clone()`
`String`	`getLocationMatchingStrategy()` Determines how this lookup matches the location.
`String`	`getLocationType()` Limits the selected developer metadata to those entries which are associated with locations of the specified type.
`Integer`	`getMetadataId()` Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id.
`String`	`getMetadataKey()` Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key.
`DeveloperMetadataLocation`	`getMetadataLocation()` Limits the selected developer metadata to those entries associated with the specified location.
`String`	`getMetadataValue()` Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value.
`String`	`getVisibility()` Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility.
`DeveloperMetadataLookup`	`set(String fieldName, Object value)`
`DeveloperMetadataLookup`	`setLocationMatchingStrategy(String locationMatchingStrategy)` Determines how this lookup matches the location.
`DeveloperMetadataLookup`	`setLocationType(String locationType)` Limits the selected developer metadata to those entries which are associated with locations of the specified type.
`DeveloperMetadataLookup`	`setMetadataId(Integer metadataId)` Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_id.
`DeveloperMetadataLookup`	`setMetadataKey(String metadataKey)` Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_key.
`DeveloperMetadataLookup`	`setMetadataLocation(DeveloperMetadataLocation metadataLocation)` Limits the selected developer metadata to those entries associated with the specified location.
`DeveloperMetadataLookup`	`setMetadataValue(String metadataValue)` Limits the selected developer metadata to that which has a matching DeveloperMetadata.metadata_value.
`DeveloperMetadataLookup`	`setVisibility(String visibility)` Limits the selected developer metadata to that which has a matching DeveloperMetadata.visibility.