Class: Google::Apis::MybusinessbusinessinformationV1::AttributeMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/mybusinessbusinessinformation_v1/classes.rb,
lib/google/apis/mybusinessbusinessinformation_v1/representations.rb,
lib/google/apis/mybusinessbusinessinformation_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AttributeMetadata

Returns a new instance of AttributeMetadata.



150
151
152
 
# File 'lib/google/apis/mybusinessbusinessinformation_v1/classes.rb', line 150

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#deprecated ⇒ Boolean Also known as: 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. Corresponds to the JSON property deprecated

Returns:

  • (Boolean) 


110
111
112
 
# File 'lib/google/apis/mybusinessbusinessinformation_v1/classes.rb', line 110

def deprecated
  @deprecated
end

#display_name ⇒ String

The localized display name for the attribute, if available; otherwise, the English display name. Corresponds to the JSON property displayName

Returns:

  • (String) 


117
118
119
 
# File 'lib/google/apis/mybusinessbusinessinformation_v1/classes.rb', line 117

def display_name
  @display_name
end

#group_display_name ⇒ String

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. Corresponds to the JSON property groupDisplayName

Returns:

  • (String) 


124
125
126
 
# File 'lib/google/apis/mybusinessbusinessinformation_v1/classes.rb', line 124

def group_display_name
  @group_display_name
end

#parent ⇒ String

The unique identifier for the attribute. Corresponds to the JSON property parent

Returns:

  • (String) 


129
130
131
 
# File 'lib/google/apis/mybusinessbusinessinformation_v1/classes.rb', line 129

def parent
  @parent
end

#repeatable ⇒ Boolean Also known as: repeatable?

If true, the attribute supports multiple values. If false, only a single value should be provided. Corresponds to the JSON property repeatable

Returns:

  • (Boolean) 


135
136
137
 
# File 'lib/google/apis/mybusinessbusinessinformation_v1/classes.rb', line 135

def repeatable
  @repeatable
end

#value_metadata ⇒ Array<Google::Apis::MybusinessbusinessinformationV1::AttributeValueMetadata>

For some types of attributes (for example, enums), a list of supported values and corresponding display names for those values is provided. Corresponds to the JSON property valueMetadata

Returns:



142
143
144
 
# File 'lib/google/apis/mybusinessbusinessinformation_v1/classes.rb', line 142

def value_metadata
  @value_metadata
end

#value_type ⇒ String

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

Returns:

  • (String) 


148
149
150
 
# File 'lib/google/apis/mybusinessbusinessinformation_v1/classes.rb', line 148

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



155
156
157
158
159
160
161
162
163
 
# File 'lib/google/apis/mybusinessbusinessinformation_v1/classes.rb', line 155

def update!(**args)
  @deprecated = args[:deprecated] if args.key?(:deprecated)
  @display_name = args[:display_name] if args.key?(:display_name)
  @group_display_name = args[:group_display_name] if args.key?(:group_display_name)
  @parent = args[:parent] if args.key?(:parent)
  @repeatable = args[:repeatable] if args.key?(:repeatable)
  @value_metadata = args[:value_metadata] if args.key?(:value_metadata)
  @value_type = args[:value_type] if args.key?(:value_type)
end