gmcgroup store the group list details
References to gmcgroup are object references.
The name part of the gmcgroup object reference has the following components:
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): name.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| name |
Description of the group
Type
String.
Create
The default value is empty.
Search
The field is available for search via
This field decides whether the members join back at the same time or sequentially with time gap of 30 seconds.
Type
String.
Create
The default value is SIMULTANEOUSLY.
Search
The field is not available for search.
gmcgroup members
Type
A/An gmcgroup member structure struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Group name
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required on creation.
Search
The field is available for search via
Notes
The name is part of the base object.
Absolute time at which the reconnect starts
Type
Timestamp.
Create
The default value is empty.
Search
The field is not available for search.
The time zone for scheduling operations.
Type
String.
Search
The field is not available for search.
Notes
The time_zone cannot be updated.
time_zone cannot be written.
This function is used for the immediate reconnecting of the GMC group members
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
gmc_group_name ( String. ). This parameter is mandatory. Name of the GMC group to reconnect to the new GM
Output fields
None
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| comment | String | N | N | N | : = ~ |
| gmc_promotion_policy | String | N | N | N | N/A |
| members | [struct] | N | N | N | N/A |
| name | String | Y | N | Y | : = ~ |
| scheduled_time | Timestamp | N | N | N | N/A |
| time_zone | String | N | Y | N | N/A |
