AdhocQueryResultSummary¶

class oci.cloud_guard.models.AdhocQueryResultSummary(**kwargs)¶

Bases: object

Adhoc query result resource from running on a resource.

Attributes

`STATE_ACCEPTED`	A constant which can be used with the state property of a AdhocQueryResultSummary.
`STATE_COMPLETED`	A constant which can be used with the state property of a AdhocQueryResultSummary.
`STATE_CREATED`	A constant which can be used with the state property of a AdhocQueryResultSummary.
`STATE_EXPIRED`	A constant which can be used with the state property of a AdhocQueryResultSummary.
`STATE_FAILED`	A constant which can be used with the state property of a AdhocQueryResultSummary.
`STATE_IN_PROGRESS`	A constant which can be used with the state property of a AdhocQueryResultSummary.
`STATE_PARTIALLY_COMPLETED`	A constant which can be used with the state property of a AdhocQueryResultSummary.
`defined_tags`	Gets the defined_tags of this AdhocQueryResultSummary.
`error_message`	Gets the error_message of this AdhocQueryResultSummary.
`freeform_tags`	Gets the freeform_tags of this AdhocQueryResultSummary.
`host_id`	[Required] Gets the host_id of this AdhocQueryResultSummary.
`region`	[Required] Gets the region of this AdhocQueryResultSummary.
`result`	Gets the result of this AdhocQueryResultSummary.
`result_count`	Gets the result_count of this AdhocQueryResultSummary.
`state`	[Required] Gets the state of this AdhocQueryResultSummary.
`system_tags`	Gets the system_tags of this AdhocQueryResultSummary.
`time_submitted`	Gets the time_submitted of this AdhocQueryResultSummary.

Methods

__init__(**kwargs) Initializes a new AdhocQueryResultSummary object with values from keyword arguments.

STATE_ACCEPTED = 'ACCEPTED'¶: A constant which can be used with the state property of a AdhocQueryResultSummary. This constant has a value of “ACCEPTED”

STATE_COMPLETED = 'COMPLETED'¶: A constant which can be used with the state property of a AdhocQueryResultSummary. This constant has a value of “COMPLETED”

STATE_CREATED = 'CREATED'¶: A constant which can be used with the state property of a AdhocQueryResultSummary. This constant has a value of “CREATED”

STATE_EXPIRED = 'EXPIRED'¶: A constant which can be used with the state property of a AdhocQueryResultSummary. This constant has a value of “EXPIRED”

STATE_FAILED = 'FAILED'¶: A constant which can be used with the state property of a AdhocQueryResultSummary. This constant has a value of “FAILED”

STATE_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the state property of a AdhocQueryResultSummary. This constant has a value of “IN_PROGRESS”

STATE_PARTIALLY_COMPLETED = 'PARTIALLY_COMPLETED'¶: A constant which can be used with the state property of a AdhocQueryResultSummary. This constant has a value of “PARTIALLY_COMPLETED”

__init__(**kwargs)¶

Initializes a new AdhocQueryResultSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

host_id (str) – The value to assign to the host_id property of this AdhocQueryResultSummary.
state (str) – The value to assign to the state property of this AdhocQueryResultSummary. Allowed values for this property are: “ACCEPTED”, “CREATED”, “IN_PROGRESS”, “COMPLETED”, “PARTIALLY_COMPLETED”, “FAILED”, “EXPIRED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
region (str) – The value to assign to the region property of this AdhocQueryResultSummary.
time_submitted (datetime) – The value to assign to the time_submitted property of this AdhocQueryResultSummary.
error_message (str) – The value to assign to the error_message property of this AdhocQueryResultSummary.
result_count (int) – The value to assign to the result_count property of this AdhocQueryResultSummary.
result (list[dict(str, str)]) – The value to assign to the result property of this AdhocQueryResultSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AdhocQueryResultSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AdhocQueryResultSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this AdhocQueryResultSummary.

defined_tags¶

Gets the defined_tags of this AdhocQueryResultSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this AdhocQueryResultSummary.
Return type:	dict(str, dict(str, object))

error_message¶

Gets the error_message of this AdhocQueryResultSummary. Optional error message

Returns:	The error_message of this AdhocQueryResultSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this AdhocQueryResultSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Avoid entering confidential information.

Returns:	The freeform_tags of this AdhocQueryResultSummary.
Return type:	dict(str, str)

host_id¶

[Required] Gets the host_id of this AdhocQueryResultSummary. Resource this result belongs to

Returns:	The host_id of this AdhocQueryResultSummary.
Return type:	str

region¶

[Required] Gets the region of this AdhocQueryResultSummary. The region this adhoc work request is running in, needed for tracking when work request is synced to reporting region

Returns:	The region of this AdhocQueryResultSummary.
Return type:	str

result¶

Gets the result of this AdhocQueryResultSummary. Result of the adhoc query this result resource is associated with

Returns:	The result of this AdhocQueryResultSummary.
Return type:	list[dict(str, str)]

result_count¶

Gets the result_count of this AdhocQueryResultSummary. Number of records returned for the query results on this host

Returns:	The result_count of this AdhocQueryResultSummary.
Return type:	int

state¶

[Required] Gets the state of this AdhocQueryResultSummary. Status of the query

Allowed values for this property are: “ACCEPTED”, “CREATED”, “IN_PROGRESS”, “COMPLETED”, “PARTIALLY_COMPLETED”, “FAILED”, “EXPIRED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The state of this AdhocQueryResultSummary.
Return type:	str

system_tags¶

Gets the system_tags of this AdhocQueryResultSummary. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this AdhocQueryResultSummary.
Return type:	dict(str, dict(str, object))

time_submitted¶

Gets the time_submitted of this AdhocQueryResultSummary. The time the adhoc result was submitted. An RFC3339 formatted datetime string

Returns:	The time_submitted of this AdhocQueryResultSummary.
Return type:	datetime