Class: Google::Apis::CloudsearchV1::ClusterInfo

Inherits:

Object

• Object
• Google::Apis::CloudsearchV1::ClusterInfo

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

ClusterInfo contains clustering related information for a particular thread that would be sent as part of the conversation view. Today, this information would be used by iOS notification server to identify whether the thread belongs to a cluster. If the thread belongs to a grouped cluster, it would identify whether the cluster is throttled.

Instance Attribute Summary

• #cluster_id ⇒ Array<String>

  IDs of the highest priority clusters to which the thread belongs to.

• #throttled ⇒ Boolean (also: #throttled?)

  If the thread belongs to a grouped cluster and all of those clusters are throttled, then this field is set to true.

Instance Method Summary

• #initialize(**args) ⇒ ClusterInfo constructor

  A new instance of ClusterInfo.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ ClusterInfo

Returns a new instance of ClusterInfo.

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

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

Instance Attribute Details

#cluster_id ⇒ Array<String>

IDs of the highest priority clusters to which the thread belongs to. If this field is not present, the thread does not belong to any cluster and would be shown in the inbox, unclustered. Corresponds to the JSON property clusterId

Returns:

• (Array<String>)

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

def cluster_id
  @cluster_id
end

#throttled ⇒ Boolean Also known as: throttled?

If the thread belongs to a grouped cluster and all of those clusters are throttled, then this field is set to true. Corresponds to the JSON property throttled

Returns:

• (Boolean)

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

def throttled
  @throttled
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

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

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