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

A group within the Cloud Identity Groups API. A Group is a collection of entities, where each entity is either a user, another group or a service account.

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.



720
721
722
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 720

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

Instance Attribute Details

#additional_group_keysArray<Google::Apis::CloudidentityV1beta1::EntityKey>

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



663
664
665
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 663

def additional_group_keys
  @additional_group_keys
end

#create_timeString

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

Returns:

  • (String)


668
669
670
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 668

def create_time
  @create_time
end

#descriptionString

An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters. Corresponds to the JSON property description

Returns:

  • (String)


674
675
676
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 674

def description
  @description
end

#display_nameString

The display name of the Group. Corresponds to the JSON property displayName

Returns:

  • (String)


679
680
681
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 679

def display_name
  @display_name
end

#group_keyGoogle::Apis::CloudidentityV1beta1::EntityKey

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



687
688
689
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 687

def group_key
  @group_key
end

#labelsHash<String,String>

Required. The labels that apply to the Group. Must not contain more than one entry. Must contain the entry 'cloudidentity.googleapis.com/groups.discussion_forum': '' if the Group is a Google Group or 'system/groups/external': '' if the Group is an external-identity-mapped group. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>)


696
697
698
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 696

def labels
  @labels
end

#nameString

Output only. The resource name of the Group. Shall be of the form groups/group_id`. Corresponds to the JSON propertyname`

Returns:

  • (String)


704
705
706
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 704

def name
  @name
end

#parentString

Required. Immutable. The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy. Must be of the form identitysources/identity_source_idfor external- identity-mapped groups or `customers/`customer_id for Google Groups. Corresponds to the JSON property parent

Returns:

  • (String)


713
714
715
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 713

def parent
  @parent
end

#update_timeString

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

Returns:

  • (String)


718
719
720
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 718

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



725
726
727
728
729
730
731
732
733
734
735
# File 'generated/google/apis/cloudidentity_v1beta1/classes.rb', line 725

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