QueueSuccessDestinationDetails

class oci.functions.models.QueueSuccessDestinationDetails(**kwargs)

Bases: SuccessDestinationDetails

The destination queue or channel in the Queue service to which to send the response of the successful detached function invocation.

Example: {“kind”: “QUEUE”, “queueId”: “queue_OCID”, “channelId”: “channel_Id”}

Attributes:

KIND_NONE

A constant which can be used with the kind property of a SuccessDestinationDetails.

KIND_NOTIFICATION

A constant which can be used with the kind property of a SuccessDestinationDetails.

KIND_QUEUE

A constant which can be used with the kind property of a SuccessDestinationDetails.

KIND_STREAM

A constant which can be used with the kind property of a SuccessDestinationDetails.

channel_id

Gets the channel_id of this QueueSuccessDestinationDetails.

kind

[Required] Gets the kind of this SuccessDestinationDetails.

queue_id

[Required] Gets the queue_id of this QueueSuccessDestinationDetails.

Methods:

__init__(**kwargs)

Initializes a new QueueSuccessDestinationDetails object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

KIND_NONE = 'NONE'

A constant which can be used with the kind property of a SuccessDestinationDetails. This constant has a value of “NONE”

KIND_NOTIFICATION = 'NOTIFICATION'

A constant which can be used with the kind property of a SuccessDestinationDetails. This constant has a value of “NOTIFICATION”

KIND_QUEUE = 'QUEUE'

A constant which can be used with the kind property of a SuccessDestinationDetails. This constant has a value of “QUEUE”

KIND_STREAM = 'STREAM'

A constant which can be used with the kind property of a SuccessDestinationDetails. This constant has a value of “STREAM”

__init__(**kwargs)

Initializes a new QueueSuccessDestinationDetails object with values from keyword arguments. The default value of the kind attribute of this class is QUEUE and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • kind (str) – The value to assign to the kind property of this QueueSuccessDestinationDetails. Allowed values for this property are: “NOTIFICATION”, “QUEUE”, “STREAM”, “NONE”

  • queue_id (str) – The value to assign to the queue_id property of this QueueSuccessDestinationDetails.

  • channel_id (str) – The value to assign to the channel_id property of this QueueSuccessDestinationDetails.

property channel_id

Gets the channel_id of this QueueSuccessDestinationDetails. The ID of the channel in the queue.

Returns

The channel_id of this QueueSuccessDestinationDetails.

Return type

str

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property kind

[Required] Gets the kind of this SuccessDestinationDetails. The type of destination for the response to a successful detached function invocation.

Allowed values for this property are: “NOTIFICATION”, “QUEUE”, “STREAM”, “NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The kind of this SuccessDestinationDetails.

Return type

str

property queue_id

[Required] Gets the queue_id of this QueueSuccessDestinationDetails. The OCID of the queue.

Returns

The queue_id of this QueueSuccessDestinationDetails.

Return type

str