/AWS1/CL_OSSCOLLGROUPDETAIL¶
Details about a collection group.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_id TYPE /AWS1/OSSCOLLECTIONGROUPID /AWS1/OSSCOLLECTIONGROUPID¶
The unique identifier of the collection group.
iv_arn TYPE /AWS1/OSSSTRING /AWS1/OSSSTRING¶
The Amazon Resource Name (ARN) of the collection group.
iv_name TYPE /AWS1/OSSCOLLECTIONGROUPNAME /AWS1/OSSCOLLECTIONGROUPNAME¶
The name of the collection group.
iv_standbyreplicas TYPE /AWS1/OSSSTANDBYREPLICAS /AWS1/OSSSTANDBYREPLICAS¶
Indicates whether standby replicas are used for the collection group.
iv_description TYPE /AWS1/OSSSTRING /AWS1/OSSSTRING¶
The description of the collection group.
it_tags TYPE /AWS1/CL_OSSTAG=>TT_TAGS TT_TAGS¶
A map of key-value pairs associated with the collection group.
iv_createddate TYPE /AWS1/OSSLONG /AWS1/OSSLONG¶
The Epoch time when the collection group was created.
io_capacitylimits TYPE REF TO /AWS1/CL_OSSCOLLGROUPCAPLIMITS /AWS1/CL_OSSCOLLGROUPCAPLIMITS¶
The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).
iv_numberofcollections TYPE /AWS1/OSSINTEGER /AWS1/OSSINTEGER¶
The number of collections associated with the collection group.
Queryable Attributes¶
id¶
The unique identifier of the collection group.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ID() |
Getter for ID, with configurable default |
ASK_ID() |
Getter for ID w/ exceptions if field has no value |
HAS_ID() |
Determine if ID has a value |
arn¶
The Amazon Resource Name (ARN) of the collection group.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
name¶
The name of the collection group.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
standbyReplicas¶
Indicates whether standby replicas are used for the collection group.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STANDBYREPLICAS() |
Getter for STANDBYREPLICAS, with configurable default |
ASK_STANDBYREPLICAS() |
Getter for STANDBYREPLICAS w/ exceptions if field has no val |
HAS_STANDBYREPLICAS() |
Determine if STANDBYREPLICAS has a value |
description¶
The description of the collection group.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
tags¶
A map of key-value pairs associated with the collection group.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |
createdDate¶
The Epoch time when the collection group was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDDATE() |
Getter for CREATEDDATE, with configurable default |
ASK_CREATEDDATE() |
Getter for CREATEDDATE w/ exceptions if field has no value |
HAS_CREATEDDATE() |
Determine if CREATEDDATE has a value |
capacityLimits¶
The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CAPACITYLIMITS() |
Getter for CAPACITYLIMITS |
numberOfCollections¶
The number of collections associated with the collection group.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NUMBEROFCOLLECTIONS() |
Getter for NUMBEROFCOLLECTIONS, with configurable default |
ASK_NUMBEROFCOLLECTIONS() |
Getter for NUMBEROFCOLLECTIONS w/ exceptions if field has no |
HAS_NUMBEROFCOLLECTIONS() |
Determine if NUMBEROFCOLLECTIONS has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_COLLECTIONGROUPDETAILS¶
TYPES TT_COLLECTIONGROUPDETAILS TYPE STANDARD TABLE OF REF TO /AWS1/CL_OSSCOLLGROUPDETAIL WITH DEFAULT KEY
.