/AWS1/CL_BDOGETDATASETRESPONSE¶
GetDatasetResponse
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_datasetarn TYPE /AWS1/BDODATASETARN /AWS1/BDODATASETARN¶
The Amazon Resource Name (ARN) of the dataset.
iv_datasetid TYPE /AWS1/BDODATASETID /AWS1/BDODATASETID¶
The unique identifier of the dataset.
iv_datasetversion TYPE /AWS1/BDODATASETVERSION /AWS1/BDODATASETVERSION¶
The resolved version: "DRAFT" (default) or the requested version number.
iv_datasetname TYPE /AWS1/BDODATASETNAME /AWS1/BDODATASETNAME¶
The name of the dataset.
iv_status TYPE /AWS1/BDODATASETSTATUS /AWS1/BDODATASETSTATUS¶
The current status of the dataset.
iv_schematype TYPE /AWS1/BDODATASETSCHEMATYPE /AWS1/BDODATASETSCHEMATYPE¶
The schema type declared at create time. Immutable after creation.
iv_examplecount TYPE /AWS1/BDOLONG /AWS1/BDOLONG¶
The number of examples in the DRAFT.
iv_createdat TYPE /AWS1/BDOTIMESTAMP /AWS1/BDOTIMESTAMP¶
The timestamp when the dataset was created.
iv_updatedat TYPE /AWS1/BDOTIMESTAMP /AWS1/BDOTIMESTAMP¶
The timestamp when the dataset was last updated.
Optional arguments:¶
iv_description TYPE /AWS1/BDOSTRING /AWS1/BDOSTRING¶
The description of the dataset.
iv_draftstatus TYPE /AWS1/BDODRAFTSTATUS /AWS1/BDODRAFTSTATUS¶
Publish synchronization state. Only authoritative when status is ACTIVE. MODIFIED indicates DRAFT has unpublished changes. UNMODIFIED indicates DRAFT matches the latest published version.
iv_failurereason TYPE /AWS1/BDOSTRING /AWS1/BDOSTRING¶
Populated when status is CREATE_FAILED, UPDATE_FAILED, or DELETE_FAILED. Describes the reason for the failure.
iv_kmskeyarn TYPE /AWS1/BDOKMSKEYARN /AWS1/BDOKMSKEYARN¶
KMS key ARN used for server-side encryption on service Amazon S3 writes, if configured.
iv_downloadurl TYPE /AWS1/BDODOWNLOADURL /AWS1/BDODOWNLOADURL¶
Presigned Amazon S3 URL to download the consolidated dataset file for the resolved version. Expires after 5 minutes. Omitted if the file does not yet exist.
iv_downloadurlexpiresat TYPE /AWS1/BDOTIMESTAMP /AWS1/BDOTIMESTAMP¶
Expiry timestamp for the download URL.
it_tags TYPE /AWS1/CL_BDOTAGSMAP_W=>TT_TAGSMAP TT_TAGSMAP¶
The tags associated with the dataset.
Queryable Attributes¶
datasetArn¶
The Amazon Resource Name (ARN) of the dataset.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATASETARN() |
Getter for DATASETARN, with configurable default |
ASK_DATASETARN() |
Getter for DATASETARN w/ exceptions if field has no value |
HAS_DATASETARN() |
Determine if DATASETARN has a value |
datasetId¶
The unique identifier of the dataset.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATASETID() |
Getter for DATASETID, with configurable default |
ASK_DATASETID() |
Getter for DATASETID w/ exceptions if field has no value |
HAS_DATASETID() |
Determine if DATASETID has a value |
datasetVersion¶
The resolved version: "DRAFT" (default) or the requested version number.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATASETVERSION() |
Getter for DATASETVERSION, with configurable default |
ASK_DATASETVERSION() |
Getter for DATASETVERSION w/ exceptions if field has no valu |
HAS_DATASETVERSION() |
Determine if DATASETVERSION has a value |
datasetName¶
The name of the dataset.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATASETNAME() |
Getter for DATASETNAME, with configurable default |
ASK_DATASETNAME() |
Getter for DATASETNAME w/ exceptions if field has no value |
HAS_DATASETNAME() |
Determine if DATASETNAME has a value |
description¶
The description of the dataset.
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 |
status¶
The current status of the dataset.
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 |
draftStatus¶
Publish synchronization state. Only authoritative when status is ACTIVE. MODIFIED indicates DRAFT has unpublished changes. UNMODIFIED indicates DRAFT matches the latest published version.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DRAFTSTATUS() |
Getter for DRAFTSTATUS, with configurable default |
ASK_DRAFTSTATUS() |
Getter for DRAFTSTATUS w/ exceptions if field has no value |
HAS_DRAFTSTATUS() |
Determine if DRAFTSTATUS has a value |
failureReason¶
Populated when status is CREATE_FAILED, UPDATE_FAILED, or DELETE_FAILED. Describes the reason for the failure.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FAILUREREASON() |
Getter for FAILUREREASON, with configurable default |
ASK_FAILUREREASON() |
Getter for FAILUREREASON w/ exceptions if field has no value |
HAS_FAILUREREASON() |
Determine if FAILUREREASON has a value |
schemaType¶
The schema type declared at create time. Immutable after creation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCHEMATYPE() |
Getter for SCHEMATYPE, with configurable default |
ASK_SCHEMATYPE() |
Getter for SCHEMATYPE w/ exceptions if field has no value |
HAS_SCHEMATYPE() |
Determine if SCHEMATYPE has a value |
kmsKeyArn¶
KMS key ARN used for server-side encryption on service Amazon S3 writes, if configured.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KMSKEYARN() |
Getter for KMSKEYARN, with configurable default |
ASK_KMSKEYARN() |
Getter for KMSKEYARN w/ exceptions if field has no value |
HAS_KMSKEYARN() |
Determine if KMSKEYARN has a value |
exampleCount¶
The number of examples in the DRAFT.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXAMPLECOUNT() |
Getter for EXAMPLECOUNT, with configurable default |
ASK_EXAMPLECOUNT() |
Getter for EXAMPLECOUNT w/ exceptions if field has no value |
HAS_EXAMPLECOUNT() |
Determine if EXAMPLECOUNT has a value |
downloadUrl¶
Presigned Amazon S3 URL to download the consolidated dataset file for the resolved version. Expires after 5 minutes. Omitted if the file does not yet exist.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DOWNLOADURL() |
Getter for DOWNLOADURL, with configurable default |
ASK_DOWNLOADURL() |
Getter for DOWNLOADURL w/ exceptions if field has no value |
HAS_DOWNLOADURL() |
Determine if DOWNLOADURL has a value |
downloadUrlExpiresAt¶
Expiry timestamp for the download URL.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DOWNLOADURLEXPIRESAT() |
Getter for DOWNLOADURLEXPIRESAT, with configurable default |
ASK_DOWNLOADURLEXPIRESAT() |
Getter for DOWNLOADURLEXPIRESAT w/ exceptions if field has n |
HAS_DOWNLOADURLEXPIRESAT() |
Determine if DOWNLOADURLEXPIRESAT has a value |
createdAt¶
The timestamp when the dataset 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 |
updatedAt¶
The timestamp when the dataset was last 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 |
tags¶
The tags associated with the dataset.
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 |