WorkRequest

class oci.analytics.models.WorkRequest(**kwargs)

Bases: object

An asynchronous work request.

Attributes:

OPERATION_TYPE_CHANGE_ANALYTICS_INSTANCE_COMPARTMENT

A constant which can be used with the operation_type property of a WorkRequest.

OPERATION_TYPE_CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT

A constant which can be used with the operation_type property of a WorkRequest.

OPERATION_TYPE_CREATE_ANALYTICS_INSTANCE

A constant which can be used with the operation_type property of a WorkRequest.

OPERATION_TYPE_CREATE_PRIVATE_ACCESS_CHANNEL

A constant which can be used with the operation_type property of a WorkRequest.

OPERATION_TYPE_CREATE_RESOURCE_GROUP

A constant which can be used with the operation_type property of a WorkRequest.

OPERATION_TYPE_CREATE_VANITY_URL

A constant which can be used with the operation_type property of a WorkRequest.

OPERATION_TYPE_DELETE_ANALYTICS_INSTANCE

A constant which can be used with the operation_type property of a WorkRequest.

OPERATION_TYPE_DELETE_PRIVATE_ACCESS_CHANNEL

A constant which can be used with the operation_type property of a WorkRequest.

OPERATION_TYPE_DELETE_RESOURCE_GROUP

A constant which can be used with the operation_type property of a WorkRequest.

OPERATION_TYPE_DELETE_VANITY_URL

A constant which can be used with the operation_type property of a WorkRequest.

OPERATION_TYPE_SCALE_ANALYTICS_INSTANCE

A constant which can be used with the operation_type property of a WorkRequest.

OPERATION_TYPE_SET_FEATURE_SET

A constant which can be used with the operation_type property of a WorkRequest.

OPERATION_TYPE_START_ANALYTICS_INSTANCE

A constant which can be used with the operation_type property of a WorkRequest.

OPERATION_TYPE_STOP_ANALYTICS_INSTANCE

A constant which can be used with the operation_type property of a WorkRequest.

OPERATION_TYPE_UPDATE_INSTANCE_ENCRYPTION_KEY

A constant which can be used with the operation_type property of a WorkRequest.

OPERATION_TYPE_UPDATE_PRIVATE_ACCESS_CHANNEL

A constant which can be used with the operation_type property of a WorkRequest.

OPERATION_TYPE_UPDATE_RESOURCE_GROUP

A constant which can be used with the operation_type property of a WorkRequest.

OPERATION_TYPE_UPDATE_VANITY_URL

A constant which can be used with the operation_type property of a WorkRequest.

STATUS_ACCEPTED

A constant which can be used with the status property of a WorkRequest.

STATUS_CANCELED

A constant which can be used with the status property of a WorkRequest.

STATUS_CANCELING

A constant which can be used with the status property of a WorkRequest.

STATUS_FAILED

A constant which can be used with the status property of a WorkRequest.

STATUS_IN_PROGRESS

A constant which can be used with the status property of a WorkRequest.

STATUS_SUCCEEDED

A constant which can be used with the status property of a WorkRequest.

compartment_id

[Required] Gets the compartment_id of this WorkRequest.

id

[Required] Gets the id of this WorkRequest.

operation_type

[Required] Gets the operation_type of this WorkRequest.

percent_complete

[Required] Gets the percent_complete of this WorkRequest.

resources

[Required] Gets the resources of this WorkRequest.

status

[Required] Gets the status of this WorkRequest.

time_accepted

[Required] Gets the time_accepted of this WorkRequest.

time_finished

Gets the time_finished of this WorkRequest.

time_started

Gets the time_started of this WorkRequest.

Methods:

__init__(**kwargs)

Initializes a new WorkRequest object with values from keyword arguments.

OPERATION_TYPE_CHANGE_ANALYTICS_INSTANCE_COMPARTMENT = 'CHANGE_ANALYTICS_INSTANCE_COMPARTMENT'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CHANGE_ANALYTICS_INSTANCE_COMPARTMENT”

OPERATION_TYPE_CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT = 'CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT”

OPERATION_TYPE_CREATE_ANALYTICS_INSTANCE = 'CREATE_ANALYTICS_INSTANCE'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CREATE_ANALYTICS_INSTANCE”

OPERATION_TYPE_CREATE_PRIVATE_ACCESS_CHANNEL = 'CREATE_PRIVATE_ACCESS_CHANNEL'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CREATE_PRIVATE_ACCESS_CHANNEL”

OPERATION_TYPE_CREATE_RESOURCE_GROUP = 'CREATE_RESOURCE_GROUP'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CREATE_RESOURCE_GROUP”

OPERATION_TYPE_CREATE_VANITY_URL = 'CREATE_VANITY_URL'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “CREATE_VANITY_URL”

OPERATION_TYPE_DELETE_ANALYTICS_INSTANCE = 'DELETE_ANALYTICS_INSTANCE'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “DELETE_ANALYTICS_INSTANCE”

OPERATION_TYPE_DELETE_PRIVATE_ACCESS_CHANNEL = 'DELETE_PRIVATE_ACCESS_CHANNEL'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “DELETE_PRIVATE_ACCESS_CHANNEL”

OPERATION_TYPE_DELETE_RESOURCE_GROUP = 'DELETE_RESOURCE_GROUP'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “DELETE_RESOURCE_GROUP”

OPERATION_TYPE_DELETE_VANITY_URL = 'DELETE_VANITY_URL'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “DELETE_VANITY_URL”

OPERATION_TYPE_SCALE_ANALYTICS_INSTANCE = 'SCALE_ANALYTICS_INSTANCE'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “SCALE_ANALYTICS_INSTANCE”

OPERATION_TYPE_SET_FEATURE_SET = 'SET_FEATURE_SET'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “SET_FEATURE_SET”

OPERATION_TYPE_START_ANALYTICS_INSTANCE = 'START_ANALYTICS_INSTANCE'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “START_ANALYTICS_INSTANCE”

OPERATION_TYPE_STOP_ANALYTICS_INSTANCE = 'STOP_ANALYTICS_INSTANCE'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “STOP_ANALYTICS_INSTANCE”

OPERATION_TYPE_UPDATE_INSTANCE_ENCRYPTION_KEY = 'UPDATE_INSTANCE_ENCRYPTION_KEY'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “UPDATE_INSTANCE_ENCRYPTION_KEY”

OPERATION_TYPE_UPDATE_PRIVATE_ACCESS_CHANNEL = 'UPDATE_PRIVATE_ACCESS_CHANNEL'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “UPDATE_PRIVATE_ACCESS_CHANNEL”

OPERATION_TYPE_UPDATE_RESOURCE_GROUP = 'UPDATE_RESOURCE_GROUP'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “UPDATE_RESOURCE_GROUP”

OPERATION_TYPE_UPDATE_VANITY_URL = 'UPDATE_VANITY_URL'

A constant which can be used with the operation_type property of a WorkRequest. This constant has a value of “UPDATE_VANITY_URL”

STATUS_ACCEPTED = 'ACCEPTED'

A constant which can be used with the status property of a WorkRequest. This constant has a value of “ACCEPTED”

STATUS_CANCELED = 'CANCELED'

A constant which can be used with the status property of a WorkRequest. This constant has a value of “CANCELED”

STATUS_CANCELING = 'CANCELING'

A constant which can be used with the status property of a WorkRequest. This constant has a value of “CANCELING”

STATUS_FAILED = 'FAILED'

A constant which can be used with the status property of a WorkRequest. This constant has a value of “FAILED”

STATUS_IN_PROGRESS = 'IN_PROGRESS'

A constant which can be used with the status property of a WorkRequest. This constant has a value of “IN_PROGRESS”

STATUS_SUCCEEDED = 'SUCCEEDED'

A constant which can be used with the status property of a WorkRequest. This constant has a value of “SUCCEEDED”

__init__(**kwargs)

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

Parameters
  • id (str) – The value to assign to the id property of this WorkRequest.

  • operation_type (str) – The value to assign to the operation_type property of this WorkRequest. Allowed values for this property are: “CREATE_ANALYTICS_INSTANCE”, “DELETE_ANALYTICS_INSTANCE”, “START_ANALYTICS_INSTANCE”, “STOP_ANALYTICS_INSTANCE”, “SCALE_ANALYTICS_INSTANCE”, “CHANGE_ANALYTICS_INSTANCE_COMPARTMENT”, “CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT”, “CREATE_VANITY_URL”, “UPDATE_VANITY_URL”, “DELETE_VANITY_URL”, “CREATE_PRIVATE_ACCESS_CHANNEL”, “UPDATE_PRIVATE_ACCESS_CHANNEL”, “DELETE_PRIVATE_ACCESS_CHANNEL”, “UPDATE_INSTANCE_ENCRYPTION_KEY”, “CREATE_RESOURCE_GROUP”, “UPDATE_RESOURCE_GROUP”, “DELETE_RESOURCE_GROUP”, “SET_FEATURE_SET”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • status (str) – The value to assign to the status property of this WorkRequest. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • compartment_id (str) – The value to assign to the compartment_id property of this WorkRequest.

  • resources (list[oci.analytics.models.WorkRequestResource]) – The value to assign to the resources property of this WorkRequest.

  • percent_complete (float) – The value to assign to the percent_complete property of this WorkRequest.

  • time_accepted (datetime) – The value to assign to the time_accepted property of this WorkRequest.

  • time_started (datetime) – The value to assign to the time_started property of this WorkRequest.

  • time_finished (datetime) – The value to assign to the time_finished property of this WorkRequest.

property compartment_id

[Required] Gets the compartment_id of this WorkRequest. The compartment OCID of this work request.

Returns

The compartment_id of this WorkRequest.

Return type

str

property id

[Required] Gets the id of this WorkRequest. The resource OCID.

Returns

The id of this WorkRequest.

Return type

str

property operation_type

[Required] Gets the operation_type of this WorkRequest. The operation performed by the work request.

Allowed values for this property are: “CREATE_ANALYTICS_INSTANCE”, “DELETE_ANALYTICS_INSTANCE”, “START_ANALYTICS_INSTANCE”, “STOP_ANALYTICS_INSTANCE”, “SCALE_ANALYTICS_INSTANCE”, “CHANGE_ANALYTICS_INSTANCE_COMPARTMENT”, “CHANGE_ANALYTICS_INSTANCE_NETWORK_ENDPOINT”, “CREATE_VANITY_URL”, “UPDATE_VANITY_URL”, “DELETE_VANITY_URL”, “CREATE_PRIVATE_ACCESS_CHANNEL”, “UPDATE_PRIVATE_ACCESS_CHANNEL”, “DELETE_PRIVATE_ACCESS_CHANNEL”, “UPDATE_INSTANCE_ENCRYPTION_KEY”, “CREATE_RESOURCE_GROUP”, “UPDATE_RESOURCE_GROUP”, “DELETE_RESOURCE_GROUP”, “SET_FEATURE_SET”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The operation_type of this WorkRequest.

Return type

str

property percent_complete

[Required] Gets the percent_complete of this WorkRequest. Percentage of the request completed.

Returns

The percent_complete of this WorkRequest.

Return type

float

property resources

[Required] Gets the resources of this WorkRequest. The resources this work request affects.

Returns

The resources of this WorkRequest.

Return type

list[oci.analytics.models.WorkRequestResource]

property status

[Required] Gets the status of this WorkRequest. The current status of the work request.

Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The status of this WorkRequest.

Return type

str

property time_accepted

[Required] Gets the time_accepted of this WorkRequest. The time the work request was accepted, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns

The time_accepted of this WorkRequest.

Return type

datetime

property time_finished

Gets the time_finished of this WorkRequest. The time the work request was finished, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns

The time_finished of this WorkRequest.

Return type

datetime

property time_started

Gets the time_started of this WorkRequest. The time the work request was started, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns

The time_started of this WorkRequest.

Return type

datetime