Class: Google::Apis::CloudidentityV1::EntityKey

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

Overview

An EntityKey uniquely identifies an Entity. Namespaces are used to provide isolation for IDs. A single ID can be reused across namespaces but the combination of a namespace and an ID must be unique.

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.


45
46
47
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 45

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

Instance Attribute Details

#idString

The ID of the entity within the given namespace. The ID must be unique within its namespace. Corresponds to the JSON property id

Returns:

  • (String)

35
36
37
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 35

def id
  @id
end

#namespaceString

Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace "identitysources/identity_source_id " is created corresponding to every Identity Source identity_source_id. Corresponds to the JSON property namespace

Returns:

  • (String)

43
44
45
# File 'generated/google/apis/cloudidentity_v1/classes.rb', line 43

def namespace
  @namespace
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


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

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