target.apidocs.com.google.api.services.sheets.v4.model.DeveloperMetadata.html Maven / Gradle / Ivy
DeveloperMetadata (Google Sheets API v4-rev20230526-2.0.0)
com.google.api.services.sheets.v4.model
Class DeveloperMetadata
- 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.DeveloperMetadata
-
public final class DeveloperMetadata
extends com.google.api.client.json.GenericJson
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 is deleted too.
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>
-
Constructor Summary
Constructors
Constructor and Description
DeveloperMetadata()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
DeveloperMetadataclone()
DeveloperMetadataLocationgetLocation()
The location where the metadata is associated.
IntegergetMetadataId()
The spreadsheet-scoped unique ID that identifies the metadata.
StringgetMetadataKey()
The metadata key.
StringgetMetadataValue()
Data associated with the metadata's key.
StringgetVisibility()
The metadata visibility.
DeveloperMetadataset(String fieldName,
Object value)
DeveloperMetadatasetLocation(DeveloperMetadataLocation location)
The location where the metadata is associated.
DeveloperMetadatasetMetadataId(Integer metadataId)
The spreadsheet-scoped unique ID that identifies the metadata.
DeveloperMetadatasetMetadataKey(String metadataKey)
The metadata key.
DeveloperMetadatasetMetadataValue(String metadataValue)
Data associated with the metadata's key.
DeveloperMetadatasetVisibility(String visibility)
The metadata 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
-
-
Method Detail
-
getLocation
public DeveloperMetadataLocation getLocation()
The location where the metadata is associated.
- Returns:
- value or
null for none
-
setLocation
public DeveloperMetadata setLocation(DeveloperMetadataLocation location)
The location where the metadata is associated.
- Parameters:
location - location or null for none
-
getMetadataId
public Integer getMetadataId()
The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when
metadata is created, otherwise one will be randomly generated and assigned. Must be positive.
- Returns:
- value or
null for none
-
setMetadataId
public DeveloperMetadata setMetadataId(Integer metadataId)
The spreadsheet-scoped unique ID that identifies the metadata. IDs may be specified when
metadata is created, otherwise one will be randomly generated and assigned. Must be positive.
- Parameters:
metadataId - metadataId or null for none
-
getMetadataKey
public String getMetadataKey()
The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer
metadata must always have a key specified.
- Returns:
- value or
null for none
-
setMetadataKey
public DeveloperMetadata setMetadataKey(String metadataKey)
The metadata key. There may be multiple metadata in a spreadsheet with the same key. Developer
metadata must always have a key specified.
- Parameters:
metadataKey - metadataKey or null for none
-
getMetadataValue
public String getMetadataValue()
Data associated with the metadata's key.
- Returns:
- value or
null for none
-
setMetadataValue
public DeveloperMetadata setMetadataValue(String metadataValue)
Data associated with the metadata's key.
- Parameters:
metadataValue - metadataValue or null for none
-
getVisibility
public String getVisibility()
The metadata visibility. Developer metadata must always have a visibility specified.
- Returns:
- value or
null for none
-
setVisibility
public DeveloperMetadata setVisibility(String visibility)
The metadata visibility. Developer metadata must always have a visibility specified.
- Parameters:
visibility - visibility or null for none
-
set
public DeveloperMetadata set(String fieldName,
Object value)
- Overrides:
set in class com.google.api.client.json.GenericJson
-
clone
public DeveloperMetadata clone()
- Overrides:
clone in class com.google.api.client.json.GenericJson
Copyright © 2011–2023 Google. All rights reserved.