Class: Google::Apis::CloudidentityV1beta1::Group

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

Resource representing a Group

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) ⇒ Group

Returns a new instance of Group



123
124
125
 
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 123

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

Instance Attribute Details

#additional_group_keys ⇒ Array<Google::Apis::CloudidentityV1beta1::EntityKey>

Optional. Additional entity key aliases for a Group Corresponds to the JSON property additionalGroupKeys

Returns:



64
65
66
 
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 64

def additional_group_keys
  @additional_group_keys
end

#create_time ⇒ String

Output only. The time when the Group was created. Output only Corresponds to the JSON property createTime

Returns:

  • (String) 


70
71
72
 
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 70

def create_time
  @create_time
end

#description ⇒ String

An extended description to help users determine the purpose of a Group. For example, you can include information about who should join the Group, the types of messages to send to the Group, links to FAQs about the Group, or related Groups. Maximum length is 4,096 characters. Corresponds to the JSON property description

Returns:

  • (String) 


78
79
80
 
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 78

def description
  @description
end

#display_name ⇒ String

The Group's display name. Corresponds to the JSON property displayName

Returns:

  • (String) 


83
84
85
 
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 83

def display_name
  @display_name
end

#group_key ⇒ Google::Apis::CloudidentityV1beta1::EntityKey

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. Corresponds to the JSON property groupKey

Returns:



90
91
92
 
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 90

def group_key
  @group_key
end

#labels ⇒ Hash<String,String>

Required. Labels for Group resource. Required. For creating Groups under a namespace, set label key to 'labels/system/groups/external' and label value as empty. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


98
99
100
 
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 98

def labels
  @labels
end

#name ⇒ String

Output only. Resource name of the Group in the format: groups/group_id`, where group_id is the unique id assigned to the Group. Must be left blank while creating a Group Corresponds to the JSON propertyname`

Returns:

  • (String) 


107
108
109
 
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 107

def name
  @name
end

#parent ⇒ String

Required. Immutable. The entity under which this Group resides in Cloud Identity resource hierarchy. Must be set when creating a Group, read-only afterwards. Currently allowed types: 'identitysources'. Corresponds to the JSON property parent

Returns:

  • (String) 


115
116
117
 
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 115

def parent
  @parent
end

#update_time ⇒ String

Output only. The time when the Group was last updated. Output only Corresponds to the JSON property updateTime

Returns:

  • (String) 


121
122
123
 
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 121

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



128
129
130
131
132
133
134
135
136
137
138
 
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 128

def update!(**args)
  @additional_group_keys = args[:additional_group_keys] if args.key?(:additional_group_keys)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @group_key = args[:group_key] if args.key?(:group_key)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @parent = args[:parent] if args.key?(:parent)
  @update_time = args[:update_time] if args.key?(:update_time)
end