Class: Google::Apis::CloudsearchV1::CircleProto

Inherits:
Object
  • Object
show all
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

Represents a Google+ Circle. Currently (12/2011), a Circle is identical to the ContactGroup with matching parameters, but Circle must only be used for true Circles and not other Focus groups, and should be preferred over ContactGroup where applicable. Soon it may become more efficient to check membership in a Circle than in a ContactGroup (see http://go/superglue). Support for this principal type is currently (12/2011) incomplete -- e.g., Keystore does not support it yet (see b/5703421).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CircleProto

Returns a new instance of CircleProto.



6323
6324
6325
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6323

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

Instance Attribute Details

#circle_id ⇒ Fixnum

Circle ID is unique only relative to the owner's Gaia ID. Currently required. Corresponds to the JSON property circleId

Returns:

  • (Fixnum) 


6305
6306
6307
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6305

def circle_id
  @circle_id
end

#owner_gaia_id ⇒ Fixnum

The owner of the circle. Currently required. Corresponds to the JSON property ownerGaiaId

Returns:

  • (Fixnum) 


6310
6311
6312
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6310

def owner_gaia_id
  @owner_gaia_id
end

#required_consistency_timestamp_usec ⇒ Fixnum

If present, then tests for membership in this circle must use data known to be at least as fresh as the given (FBS-assigned) timestamp. See http://go/fbs- consistent-read-after-important-write Before using this, be sure that any service checking authorization against this circle supports checking consistency timestamps. For example, as of 12/2011, Keystore only supports this for the Moonshine configuration, and in others authorization checks will fail if the timestamp is present. Corresponds to the JSON property requiredConsistencyTimestampUsec

Returns:

  • (Fixnum) 


6321
6322
6323
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6321

def required_consistency_timestamp_usec
  @required_consistency_timestamp_usec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6328
6329
6330
6331
6332
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6328

def update!(**args)
  @circle_id = args[:circle_id] if args.key?(:circle_id)
  @owner_gaia_id = args[:owner_gaia_id] if args.key?(:owner_gaia_id)
  @required_consistency_timestamp_usec = args[:required_consistency_timestamp_usec] if args.key?(:required_consistency_timestamp_usec)
end