/AWS1/CL_IVRINGESTCONFSUMMARY¶
Summary information about an IngestConfiguration.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_arn TYPE /AWS1/IVRINGESTCONFARN /AWS1/IVRINGESTCONFARN¶
Ingest configuration ARN.
iv_ingestprotocol TYPE /AWS1/IVRINGESTPROTOCOL /AWS1/IVRINGESTPROTOCOL¶
Type of ingest protocol that the user employs for broadcasting.
iv_stagearn TYPE /AWS1/IVRINGESTCONFSTAGEARN /AWS1/IVRINGESTCONFSTAGEARN¶
ARN of the stage with which the IngestConfiguration is associated.
iv_participantid TYPE /AWS1/IVRPARTICIPANTID /AWS1/IVRPARTICIPANTID¶
ID of the participant within the stage.
iv_state TYPE /AWS1/IVRINGESTCONFSTATE /AWS1/IVRINGESTCONFSTATE¶
State of the ingest configuration. It is
ACTIVEif a publisher currently is publishing to the stage associated with the ingest configuration.
Optional arguments:¶
iv_name TYPE /AWS1/IVRINGESTCONFNAME /AWS1/IVRINGESTCONFNAME¶
Ingest name.
iv_userid TYPE /AWS1/IVRUSERID /AWS1/IVRUSERID¶
Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
iv_redundantingest TYPE /AWS1/IVRREDUNDANTINGEST /AWS1/IVRREDUNDANTINGEST¶
Indicates whether redundant ingest is enabled for the ingest configuration.
Queryable Attributes¶
name¶
Ingest name.
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 |
arn¶
Ingest configuration ARN.
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 |
ingestProtocol¶
Type of ingest protocol that the user employs for broadcasting.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INGESTPROTOCOL() |
Getter for INGESTPROTOCOL, with configurable default |
ASK_INGESTPROTOCOL() |
Getter for INGESTPROTOCOL w/ exceptions if field has no valu |
HAS_INGESTPROTOCOL() |
Determine if INGESTPROTOCOL has a value |
stageArn¶
ARN of the stage with which the IngestConfiguration is associated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STAGEARN() |
Getter for STAGEARN, with configurable default |
ASK_STAGEARN() |
Getter for STAGEARN w/ exceptions if field has no value |
HAS_STAGEARN() |
Determine if STAGEARN has a value |
participantId¶
ID of the participant within the stage.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PARTICIPANTID() |
Getter for PARTICIPANTID, with configurable default |
ASK_PARTICIPANTID() |
Getter for PARTICIPANTID w/ exceptions if field has no value |
HAS_PARTICIPANTID() |
Determine if PARTICIPANTID has a value |
state¶
State of the ingest configuration. It is
ACTIVEif a publisher currently is publishing to the stage associated with the ingest configuration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATE() |
Getter for STATE, with configurable default |
ASK_STATE() |
Getter for STATE w/ exceptions if field has no value |
HAS_STATE() |
Determine if STATE has a value |
userId¶
Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USERID() |
Getter for USERID, with configurable default |
ASK_USERID() |
Getter for USERID w/ exceptions if field has no value |
HAS_USERID() |
Determine if USERID has a value |
redundantIngest¶
Indicates whether redundant ingest is enabled for the ingest configuration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REDUNDANTINGEST() |
Getter for REDUNDANTINGEST |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_INGESTCONFIGURATIONLIST¶
TYPES TT_INGESTCONFIGURATIONLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_IVRINGESTCONFSUMMARY WITH DEFAULT KEY
.