/AWS1/CL_TBDGETQUEUERESPONSE¶
Mixin that adds an optional ARN field to response structures. Apply to SummaryMixins (flows into Get, Summary, and BatchGet) and Create outputs.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_farmid TYPE /AWS1/TBDFARMID /AWS1/TBDFARMID¶
The farm ID for the queue.
iv_queueid TYPE /AWS1/TBDQUEUEID /AWS1/TBDQUEUEID¶
The queue ID.
iv_displayname TYPE /AWS1/TBDRESOURCENAME /AWS1/TBDRESOURCENAME¶
The display name of the queue.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
iv_status TYPE /AWS1/TBDQUEUESTATUS /AWS1/TBDQUEUESTATUS¶
The status of the queue.
ACTIVE–The queue is active.
SCHEDULING–The queue is scheduling.
SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.
iv_defaultbudgetaction TYPE /AWS1/TBDDEFQUEUEBUDGETACTION /AWS1/TBDDEFQUEUEBUDGETACTION¶
The default action taken on a queue if a budget wasn't configured.
iv_createdat TYPE /AWS1/TBDCREATEDAT /AWS1/TBDCREATEDAT¶
The date and time the resource was created.
iv_createdby TYPE /AWS1/TBDCREATEDBY /AWS1/TBDCREATEDBY¶
The user or system that created this resource.
Optional arguments:¶
iv_blockedreason TYPE /AWS1/TBDQUEUEBLOCKEDREASON /AWS1/TBDQUEUEBLOCKEDREASON¶
The reason the queue was blocked.
iv_updatedat TYPE /AWS1/TBDUPDATEDAT /AWS1/TBDUPDATEDAT¶
The date and time the resource was updated.
iv_updatedby TYPE /AWS1/TBDUPDATEDBY /AWS1/TBDUPDATEDBY¶
The user or system that updated this resource.
iv_description TYPE /AWS1/TBDDESCRIPTION /AWS1/TBDDESCRIPTION¶
The description of the queue.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
io_jobattachmentsettings TYPE REF TO /AWS1/CL_TBDJOBATTACHMENTSTGS /AWS1/CL_TBDJOBATTACHMENTSTGS¶
The job attachment settings for the queue.
iv_rolearn TYPE /AWS1/TBDIAMROLEARN /AWS1/TBDIAMROLEARN¶
The IAM role ARN.
it_requiredfilesystemlocna00 TYPE /AWS1/CL_TBDREQUIREDFILESYST00=>TT_REQUIREDFILESYSTEMLOCNAMES TT_REQUIREDFILESYSTEMLOCNAMES¶
A list of the required file system location names in the queue.
it_allowedstorageprofileids TYPE /AWS1/CL_TBDALWEDSTRGPFLIDS_W=>TT_ALLOWEDSTORAGEPROFILEIDS TT_ALLOWEDSTORAGEPROFILEIDS¶
The storage profile IDs for the queue.
io_jobrunasuser TYPE REF TO /AWS1/CL_TBDJOBRUNASUSER /AWS1/CL_TBDJOBRUNASUSER¶
The jobs in the queue ran as this specified POSIX user.
io_schedulingconfiguration TYPE REF TO /AWS1/CL_TBDSCHEDULINGCONF /AWS1/CL_TBDSCHEDULINGCONF¶
The scheduling configuration for the queue. This configuration determines how workers are assigned to jobs in the queue.
Queryable Attributes¶
farmId¶
The farm ID for the queue.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FARMID() |
Getter for FARMID, with configurable default |
ASK_FARMID() |
Getter for FARMID w/ exceptions if field has no value |
HAS_FARMID() |
Determine if FARMID has a value |
queueId¶
The queue ID.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_QUEUEID() |
Getter for QUEUEID, with configurable default |
ASK_QUEUEID() |
Getter for QUEUEID w/ exceptions if field has no value |
HAS_QUEUEID() |
Determine if QUEUEID has a value |
displayName¶
The display name of the queue.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DISPLAYNAME() |
Getter for DISPLAYNAME, with configurable default |
ASK_DISPLAYNAME() |
Getter for DISPLAYNAME w/ exceptions if field has no value |
HAS_DISPLAYNAME() |
Determine if DISPLAYNAME has a value |
status¶
The status of the queue.
ACTIVE–The queue is active.
SCHEDULING–The queue is scheduling.
SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
defaultBudgetAction¶
The default action taken on a queue if a budget wasn't configured.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEFAULTBUDGETACTION() |
Getter for DEFAULTBUDGETACTION, with configurable default |
ASK_DEFAULTBUDGETACTION() |
Getter for DEFAULTBUDGETACTION w/ exceptions if field has no |
HAS_DEFAULTBUDGETACTION() |
Determine if DEFAULTBUDGETACTION has a value |
blockedReason¶
The reason the queue was blocked.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BLOCKEDREASON() |
Getter for BLOCKEDREASON, with configurable default |
ASK_BLOCKEDREASON() |
Getter for BLOCKEDREASON w/ exceptions if field has no value |
HAS_BLOCKEDREASON() |
Determine if BLOCKEDREASON has a value |
createdAt¶
The date and time the resource was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
createdBy¶
The user or system that created this resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDBY() |
Getter for CREATEDBY, with configurable default |
ASK_CREATEDBY() |
Getter for CREATEDBY w/ exceptions if field has no value |
HAS_CREATEDBY() |
Determine if CREATEDBY has a value |
updatedAt¶
The date and time the resource was updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UPDATEDAT() |
Getter for UPDATEDAT, with configurable default |
ASK_UPDATEDAT() |
Getter for UPDATEDAT w/ exceptions if field has no value |
HAS_UPDATEDAT() |
Determine if UPDATEDAT has a value |
updatedBy¶
The user or system that updated this resource.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UPDATEDBY() |
Getter for UPDATEDBY, with configurable default |
ASK_UPDATEDBY() |
Getter for UPDATEDBY w/ exceptions if field has no value |
HAS_UPDATEDBY() |
Determine if UPDATEDBY has a value |
description¶
The description of the queue.
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
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 |
jobAttachmentSettings¶
The job attachment settings for the queue.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_JOBATTACHMENTSETTINGS() |
Getter for JOBATTACHMENTSETTINGS |
roleArn¶
The IAM role ARN.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLEARN() |
Getter for ROLEARN, with configurable default |
ASK_ROLEARN() |
Getter for ROLEARN w/ exceptions if field has no value |
HAS_ROLEARN() |
Determine if ROLEARN has a value |
requiredFileSystemLocationNames¶
A list of the required file system location names in the queue.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REQUIREDFILESYSTEMLOCN00() |
Getter for REQUIREDFILESYSTEMLOCNAMES, with configurable def |
ASK_REQUIREDFILESYSTEMLOCN00() |
Getter for REQUIREDFILESYSTEMLOCNAMES w/ exceptions if field |
HAS_REQUIREDFILESYSTEMLOCN00() |
Determine if REQUIREDFILESYSTEMLOCNAMES has a value |
allowedStorageProfileIds¶
The storage profile IDs for the queue.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ALLOWEDSTORAGEPROFILEIDS() |
Getter for ALLOWEDSTORAGEPROFILEIDS, with configurable defau |
ASK_ALLOWEDSTORAGEPROFILEIDS() |
Getter for ALLOWEDSTORAGEPROFILEIDS w/ exceptions if field h |
HAS_ALLOWEDSTORAGEPROFILEIDS() |
Determine if ALLOWEDSTORAGEPROFILEIDS has a value |
jobRunAsUser¶
The jobs in the queue ran as this specified POSIX user.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_JOBRUNASUSER() |
Getter for JOBRUNASUSER |
schedulingConfiguration¶
The scheduling configuration for the queue. This configuration determines how workers are assigned to jobs in the queue.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCHEDULINGCONFIGURATION() |
Getter for SCHEDULINGCONFIGURATION |