Class: Google::Apis::CloudidentityV1beta1::EntityKey

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudidentity_v1beta1/classes.rb,
generated/google/apis/cloudidentity_v1beta1/representations.rb,
generated/google/apis/cloudidentity_v1beta1/representations.rb

Overview

A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional namespace or a user without a namespace. The combination of id and namespace must be unique; however, the same id can be used with different namespaces.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ EntityKey

Returns a new instance of EntityKey.



52
53
54
 
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 52

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

Instance Attribute Details

#id ⇒ String

The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace. Corresponds to the JSON property id

Returns:

  • (String) 


40
41
42
 
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 40

def id
  @id
end

#namespace ⇒ String

The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console. Must be of the form identitysources/identity_source_id. Corresponds to the JSON propertynamespace`

Returns:

  • (String) 


50
51
52
 
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 50

def namespace
  @namespace
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



57
58
59
60
 
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 57

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