com.google.api.services.mybusinessbusinessinformation.v1.model

Class AttributeMetadata

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.mybusinessbusinessinformation.v1.model.AttributeMetadata

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class AttributeMetadata
extends com.google.api.client.json.GenericJson

Metadata for an attribute. Contains display information for the attribute, including a localized name and a heading for grouping related attributes together.

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 My Business Business Information 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
AttributeMetadata()

Method Summary

Modifier and Type	Method and Description
AttributeMetadata	clone()
Boolean	getDeprecated() If true, the attribute is deprecated and should no longer be used.
String	getDisplayName() The localized display name for the attribute, if available; otherwise, the English display name.
String	getGroupDisplayName() The localized display name of the group that contains this attribute, if available; otherwise, the English group name.
String	getParent() The unique identifier for the attribute.
Boolean	getRepeatable() If true, the attribute supports multiple values.
List<AttributeValueMetadata>	getValueMetadata() For some types of attributes (for example, enums), a list of supported values and corresponding display names for those values is provided.
String	getValueType() The value type for the attribute.
AttributeMetadata	set(String fieldName, Object value)
AttributeMetadata	setDeprecated(Boolean deprecated) If true, the attribute is deprecated and should no longer be used.
AttributeMetadata	setDisplayName(String displayName) The localized display name for the attribute, if available; otherwise, the English display name.
AttributeMetadata	setGroupDisplayName(String groupDisplayName) The localized display name of the group that contains this attribute, if available; otherwise, the English group name.
AttributeMetadata	setParent(String parent) The unique identifier for the attribute.
AttributeMetadata	setRepeatable(Boolean repeatable) If true, the attribute supports multiple values.
AttributeMetadata	setValueMetadata(List<AttributeValueMetadata> valueMetadata) For some types of attributes (for example, enums), a list of supported values and corresponding display names for those values is provided.
AttributeMetadata	setValueType(String valueType) The value type for the attribute.

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

AttributeMetadata

public AttributeMetadata()

Method Detail

getDeprecated

public Boolean getDeprecated()

If true, the attribute is deprecated and should no longer be used. If deprecated, updating this attribute will not result in an error, but updates will not be saved. At some point after being deprecated, the attribute will be removed entirely and it will become an error.

Returns:

value or null for none

setDeprecated

public AttributeMetadata setDeprecated(Boolean deprecated)

If true, the attribute is deprecated and should no longer be used. If deprecated, updating this attribute will not result in an error, but updates will not be saved. At some point after being deprecated, the attribute will be removed entirely and it will become an error.

Parameters:

deprecated - deprecated or null for none

getDisplayName

public String getDisplayName()

The localized display name for the attribute, if available; otherwise, the English display name.

Returns:

value or null for none

setDisplayName

public AttributeMetadata setDisplayName(String displayName)

The localized display name for the attribute, if available; otherwise, the English display name.

Parameters:

displayName - displayName or null for none

getGroupDisplayName

public String getGroupDisplayName()

The localized display name of the group that contains this attribute, if available; otherwise, the English group name. Related attributes are collected into a group and should be displayed together under the heading given here.

Returns:

value or null for none

setGroupDisplayName

public AttributeMetadata setGroupDisplayName(String groupDisplayName)

The localized display name of the group that contains this attribute, if available; otherwise, the English group name. Related attributes are collected into a group and should be displayed together under the heading given here.

Parameters:

groupDisplayName - groupDisplayName or null for none

getParent

public String getParent()

The unique identifier for the attribute.

Returns:

value or null for none

setParent

public AttributeMetadata setParent(String parent)

The unique identifier for the attribute.

Parameters:

parent - parent or null for none

getRepeatable

public Boolean getRepeatable()

If true, the attribute supports multiple values. If false, only a single value should be provided.

Returns:

value or null for none

setRepeatable

public AttributeMetadata setRepeatable(Boolean repeatable)

If true, the attribute supports multiple values. If false, only a single value should be provided.

Parameters:

repeatable - repeatable or null for none

getValueMetadata

public List<AttributeValueMetadata> getValueMetadata()

For some types of attributes (for example, enums), a list of supported values and corresponding display names for those values is provided.

Returns:

value or null for none

setValueMetadata

public AttributeMetadata setValueMetadata(List<AttributeValueMetadata> valueMetadata)

For some types of attributes (for example, enums), a list of supported values and corresponding display names for those values is provided.

Parameters:

valueMetadata - valueMetadata or null for none

getValueType

public String getValueType()

The value type for the attribute. Values set and retrieved should be expected to be of this type.

Returns:

value or null for none

setValueType

public AttributeMetadata setValueType(String valueType)

The value type for the attribute. Values set and retrieved should be expected to be of this type.

Parameters:

valueType - valueType or null for none

set

public AttributeMetadata set(String fieldName,
                             Object value)

Overrides:

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

clone

public AttributeMetadata clone()

Overrides:

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