scavengingtask : DNS scavenging task object.¶
The DNS scavenging task object provides information on scavenging process state.
Object Reference¶
References to scavengingtask are object references. The name part of a DNS scavenging task object reference has the following components:
Task identifier
Example: scavengingtask/ZG5zLm5ldHdvcmtfdmlldyQxMTk:1
Restrictions¶
The object does not support the following operations:
Create (insert)
Delete
Modify (update)
Permissions
Global search (searches via the search object)
CSV export
The object cannot be managed on Cloud Platform members.
Fields¶
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): action, associated_object, status.
action¶
- action¶
The scavenging action.
Type
String.
- Valid values are:
ANALYZE
ANALYZE_RECLAIM
RECLAIM
RESET
Search
The field is available for search via
‘=’ (exact equality)
Notes
The action is part of the base object.
The action cannot be updated.
action cannot be written.
associated_object¶
- associated_object¶
The reference to the object associated with the scavenging task.
Type
String.
This field supports nested return fields as described here.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The associated_object is part of the base object.
The associated_object cannot be updated.
associated_object cannot be written.
end_time¶
- end_time¶
The scavenging process end time.
Type
Timestamp.
Search
The field is not available for search.
Notes
The end_time cannot be updated.
end_time cannot be written.
processed_records¶
- processed_records¶
The number of processed during scavenging resource records.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The processed_records cannot be updated.
processed_records cannot be written.
reclaimable_records¶
- reclaimable_records¶
The number of resource records that are allowed to be reclaimed during the scavenging process.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The reclaimable_records cannot be updated.
reclaimable_records cannot be written.
reclaimed_records¶
- reclaimed_records¶
The number of reclaimed during the scavenging process resource records.
Type
Unsigned integer.
Search
The field is not available for search.
Notes
The reclaimed_records cannot be updated.
reclaimed_records cannot be written.
start_time¶
- start_time¶
The scavenging process start time.
Type
Timestamp.
Search
The field is not available for search.
Notes
The start_time cannot be updated.
start_time cannot be written.
status¶
- status¶
The scavenging process status. This is a read-only attribute.
Type
String.
- Valid values are:
COMPLETED
CREATED
ERROR
RUNNING
Search
The field is available for search via
‘=’ (exact equality)
Notes
The status is part of the base object.
The status cannot be updated.
status cannot be written.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
action |
String |
N |
Y |
Y |
= |
associated_object |
String |
N |
Y |
Y |
= |
end_time |
Timestamp |
N |
Y |
N |
N/A |
processed_records |
Unsigned int |
N |
Y |
N |
N/A |
reclaimable_records |
Unsigned int |
N |
Y |
N |
N/A |
reclaimed_records |
Unsigned int |
N |
Y |
N |
N/A |
start_time |
Timestamp |
N |
Y |
N |
N/A |
status |
String |
N |
Y |
Y |
= |
