Class: Google::Apis::CloudsearchV1::Attribute

Inherits:

Object

• Object
• Google::Apis::CloudsearchV1::Attribute

Includes:

Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport

Defined in:

lib/google/apis/cloudsearch_v1/classes.rb,
lib/google/apis/cloudsearch_v1/representations.rb,
lib/google/apis/cloudsearch_v1/representations.rb

Overview

An Attribute is a piece of data attached an Item. Attributes are opaque to the Starbox and have no effect on, nor are they effected by, message storage, indexing, or search.

Instance Attribute Summary

• #name ⇒ String

  The name of the attribute.

• #value ⇒ Google::Apis::CloudsearchV1::CaribouAttributeValue

  Corresponds to the JSON property value.

Instance Method Summary

• #initialize(**args) ⇒ Attribute constructor

  A new instance of Attribute.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ Attribute

Returns a new instance of Attribute.

# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4824

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

Instance Attribute Details

#name ⇒ String

The name of the attribute. Required - If a write is attempted with an empty string, the server will return an error. Corresponds to the JSON property name

Returns:

• (String)

# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4817

def name
  @name
end

#value ⇒ Google::Apis::CloudsearchV1::CaribouAttributeValue

Corresponds to the JSON property value

Returns:

• (Google::Apis::CloudsearchV1::CaribouAttributeValue)

# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4822

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4829

def update!(**args)
  @name = args[:name] if args.key?(:name)
  @value = args[:value] if args.key?(:value)
end