/AWS1/CL_PIPACTIONCONFPROPERTY¶
Represents information about an action configuration property.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_name TYPE /AWS1/PIPACTIONCONFKEY /AWS1/PIPACTIONCONFKEY¶
The name of the action configuration property.
iv_required TYPE /AWS1/PIPBOOLEAN /AWS1/PIPBOOLEAN¶
Whether the configuration property is a required value.
iv_key TYPE /AWS1/PIPBOOLEAN /AWS1/PIPBOOLEAN¶
Whether the configuration property is a key.
iv_secret TYPE /AWS1/PIPBOOLEAN /AWS1/PIPBOOLEAN¶
Whether the configuration property is secret. Secrets are hidden from all calls except for
GetJobDetails,GetThirdPartyJobDetails,PollForJobs, andPollForThirdPartyJobs.When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
Optional arguments:¶
iv_queryable TYPE /AWS1/PIPBOOLEAN /AWS1/PIPBOOLEAN¶
Indicates that the property is used with
PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
iv_description TYPE /AWS1/PIPDESCRIPTION /AWS1/PIPDESCRIPTION¶
The description of the action configuration property that is displayed to users.
iv_type TYPE /AWS1/PIPACTIONCONFPRPTYPE /AWS1/PIPACTIONCONFPRPTYPE¶
The type of the configuration property.
Queryable Attributes¶
name¶
The name of the action configuration property.
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 |
required¶
Whether the configuration property is a required value.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REQUIRED() |
Getter for REQUIRED |
key¶
Whether the configuration property is a key.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KEY() |
Getter for KEY |
secret¶
Whether the configuration property is secret. Secrets are hidden from all calls except for
GetJobDetails,GetThirdPartyJobDetails,PollForJobs, andPollForThirdPartyJobs.When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SECRET() |
Getter for SECRET |
queryable¶
Indicates that the property is used with
PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_QUERYABLE() |
Getter for QUERYABLE |
description¶
The description of the action configuration property that is displayed to users.
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 |
type¶
The type of the configuration property.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE 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_ACTIONCONFPROPERTYLIST¶
TYPES TT_ACTIONCONFPROPERTYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_PIPACTIONCONFPROPERTY WITH DEFAULT KEY
.