oci 2.111.0__py3-none-any.whl → 2.112.0__py3-none-any.whl

oci/queue/models/channel_collection.py

@@ -0,0 +1,72 @@
+# coding: utf-8
+# Copyright (c) 2016, 2023, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210201
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class ChannelCollection(object):
+    """
+    List of IDs of non-empty channels.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new ChannelCollection object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param items:
+            The value to assign to the items property of this ChannelCollection.
+        :type items: list[str]
+
+        """
+        self.swagger_types = {
+            'items': 'list[str]'
+        }
+
+        self.attribute_map = {
+            'items': 'items'
+        }
+
+        self._items = None
+
+    @property
+    def items(self):
+        """
+        **[Required]** Gets the items of this ChannelCollection.
+        The approximate list of IDs of non-empty channels.
+
+
+        :return: The items of this ChannelCollection.
+        :rtype: list[str]
+        """
+        return self._items
+
+    @items.setter
+    def items(self, items):
+        """
+        Sets the items of this ChannelCollection.
+        The approximate list of IDs of non-empty channels.
+
+
+        :param items: The items of this ChannelCollection.
+        :type: list[str]
+        """
+        self._items = items
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/queue/models/create_queue_details.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class CreateQueueDetails(object):
     """
-    The information about new Queue.
+    The information about a new queue.
     """
 
     def __init__(self, **kwargs):
@@ -40,6 +40,10 @@ class CreateQueueDetails(object):
             The value to assign to the timeout_in_seconds property of this CreateQueueDetails.
         :type timeout_in_seconds: int
 
+        :param channel_consumption_limit:
+            The value to assign to the channel_consumption_limit property of this CreateQueueDetails.
+        :type channel_consumption_limit: int
+
         :param dead_letter_queue_delivery_count:
             The value to assign to the dead_letter_queue_delivery_count property of this CreateQueueDetails.
         :type dead_letter_queue_delivery_count: int
@@ -63,6 +67,7 @@ class CreateQueueDetails(object):
             'retention_in_seconds': 'int',
             'visibility_in_seconds': 'int',
             'timeout_in_seconds': 'int',
+            'channel_consumption_limit': 'int',
             'dead_letter_queue_delivery_count': 'int',
             'custom_encryption_key_id': 'str',
             'freeform_tags': 'dict(str, str)',
@@ -75,6 +80,7 @@ class CreateQueueDetails(object):
             'retention_in_seconds': 'retentionInSeconds',
             'visibility_in_seconds': 'visibilityInSeconds',
             'timeout_in_seconds': 'timeoutInSeconds',
+            'channel_consumption_limit': 'channelConsumptionLimit',
             'dead_letter_queue_delivery_count': 'deadLetterQueueDeliveryCount',
             'custom_encryption_key_id': 'customEncryptionKeyId',
             'freeform_tags': 'freeformTags',
@@ -86,6 +92,7 @@ class CreateQueueDetails(object):
         self._retention_in_seconds = None
         self._visibility_in_seconds = None
         self._timeout_in_seconds = None
+        self._channel_consumption_limit = None
         self._dead_letter_queue_delivery_count = None
         self._custom_encryption_key_id = None
         self._freeform_tags = None
@@ -95,7 +102,7 @@ class CreateQueueDetails(object):
     def display_name(self):
         """
         **[Required]** Gets the display_name of this CreateQueueDetails.
-        Queue Identifier
+        The user-friendly name of the queue.
 
 
         :return: The display_name of this CreateQueueDetails.
@@ -107,7 +114,7 @@ class CreateQueueDetails(object):
     def display_name(self, display_name):
         """
         Sets the display_name of this CreateQueueDetails.
-        Queue Identifier
+        The user-friendly name of the queue.
 
 
         :param display_name: The display_name of this CreateQueueDetails.
@@ -119,7 +126,9 @@ class CreateQueueDetails(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this CreateQueueDetails.
-        Compartment Identifier
+        The `OCID`__ of the compartment containing the queue.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
 
         :return: The compartment_id of this CreateQueueDetails.
@@ -131,7 +140,9 @@ class CreateQueueDetails(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this CreateQueueDetails.
-        Compartment Identifier
+        The `OCID`__ of the compartment containing the queue.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
 
         :param compartment_id: The compartment_id of this CreateQueueDetails.
@@ -143,7 +154,7 @@ class CreateQueueDetails(object):
     def retention_in_seconds(self):
         """
         Gets the retention_in_seconds of this CreateQueueDetails.
-        The retention period of the messages in the queue, in seconds.
+        The retention period of messages in the queue, in seconds.
 
 
         :return: The retention_in_seconds of this CreateQueueDetails.
@@ -155,7 +166,7 @@ class CreateQueueDetails(object):
     def retention_in_seconds(self, retention_in_seconds):
         """
         Sets the retention_in_seconds of this CreateQueueDetails.
-        The retention period of the messages in the queue, in seconds.
+        The retention period of messages in the queue, in seconds.
 
 
         :param retention_in_seconds: The retention_in_seconds of this CreateQueueDetails.
@@ -167,7 +178,7 @@ class CreateQueueDetails(object):
     def visibility_in_seconds(self):
         """
         Gets the visibility_in_seconds of this CreateQueueDetails.
-        The default visibility of the messages consumed from the queue.
+        The default visibility timeout of the messages consumed from the queue, in seconds.
 
 
         :return: The visibility_in_seconds of this CreateQueueDetails.
@@ -179,7 +190,7 @@ class CreateQueueDetails(object):
     def visibility_in_seconds(self, visibility_in_seconds):
         """
         Sets the visibility_in_seconds of this CreateQueueDetails.
-        The default visibility of the messages consumed from the queue.
+        The default visibility timeout of the messages consumed from the queue, in seconds.
 
 
         :param visibility_in_seconds: The visibility_in_seconds of this CreateQueueDetails.
@@ -211,6 +222,30 @@ class CreateQueueDetails(object):
         """
         self._timeout_in_seconds = timeout_in_seconds
 
+    @property
+    def channel_consumption_limit(self):
+        """
+        Gets the channel_consumption_limit of this CreateQueueDetails.
+        The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel  can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources.
+
+
+        :return: The channel_consumption_limit of this CreateQueueDetails.
+        :rtype: int
+        """
+        return self._channel_consumption_limit
+
+    @channel_consumption_limit.setter
+    def channel_consumption_limit(self, channel_consumption_limit):
+        """
+        Sets the channel_consumption_limit of this CreateQueueDetails.
+        The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel  can't exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue's resources.
+
+
+        :param channel_consumption_limit: The channel_consumption_limit of this CreateQueueDetails.
+        :type: int
+        """
+        self._channel_consumption_limit = channel_consumption_limit
+
     @property
     def dead_letter_queue_delivery_count(self):
         """
@@ -239,7 +274,9 @@ class CreateQueueDetails(object):
     def custom_encryption_key_id(self):
         """
         Gets the custom_encryption_key_id of this CreateQueueDetails.
-        Id of the custom master encryption key which will be used to encrypt messages content
+        The `OCID`__ of the custom encryption key to be used to encrypt messages content.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
 
         :return: The custom_encryption_key_id of this CreateQueueDetails.
@@ -251,7 +288,9 @@ class CreateQueueDetails(object):
     def custom_encryption_key_id(self, custom_encryption_key_id):
         """
         Sets the custom_encryption_key_id of this CreateQueueDetails.
-        Id of the custom master encryption key which will be used to encrypt messages content
+        The `OCID`__ of the custom encryption key to be used to encrypt messages content.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
 
         :param custom_encryption_key_id: The custom_encryption_key_id of this CreateQueueDetails.

oci/queue/models/delete_messages_details_entry.py

@@ -39,7 +39,7 @@ class DeleteMessagesDetailsEntry(object):
     def receipt(self):
         """
         **[Required]** Gets the receipt of this DeleteMessagesDetailsEntry.
-        The receipt of the message to delete
+        The receipt of the message to delete.
 
 
         :return: The receipt of this DeleteMessagesDetailsEntry.
@@ -51,7 +51,7 @@ class DeleteMessagesDetailsEntry(object):
     def receipt(self, receipt):
         """
         Sets the receipt of this DeleteMessagesDetailsEntry.
-        The receipt of the message to delete
+        The receipt of the message to delete.
 
 
         :param receipt: The receipt of this DeleteMessagesDetailsEntry.

oci/queue/models/get_message.py

@@ -44,6 +44,10 @@ class GetMessage(object):
             The value to assign to the expire_after property of this GetMessage.
         :type expire_after: datetime
 
+        :param metadata:
+            The value to assign to the metadata property of this GetMessage.
+        :type metadata: oci.queue.models.MessageMetadata
+
         """
         self.swagger_types = {
             'id': 'int',
@@ -51,7 +55,8 @@ class GetMessage(object):
             'receipt': 'str',
             'delivery_count': 'int',
             'visible_after': 'datetime',
-            'expire_after': 'datetime'
+            'expire_after': 'datetime',
+            'metadata': 'MessageMetadata'
         }
 
         self.attribute_map = {
@@ -60,7 +65,8 @@ class GetMessage(object):
             'receipt': 'receipt',
             'delivery_count': 'deliveryCount',
             'visible_after': 'visibleAfter',
-            'expire_after': 'expireAfter'
+            'expire_after': 'expireAfter',
+            'metadata': 'metadata'
         }
 
         self._id = None
@@ -69,12 +75,13 @@ class GetMessage(object):
         self._delivery_count = None
         self._visible_after = None
         self._expire_after = None
+        self._metadata = None
 
     @property
     def id(self):
         """
         **[Required]** Gets the id of this GetMessage.
-        The id of the message - this is only used for tracing and debugging purposes and isn't used as a parameter in any request.
+        The ID of the message. This ID is only used for tracing and debugging purposes and isn't used as a parameter in any request.
 
 
         :return: The id of this GetMessage.
@@ -86,7 +93,7 @@ class GetMessage(object):
     def id(self, id):
         """
         Sets the id of this GetMessage.
-        The id of the message - this is only used for tracing and debugging purposes and isn't used as a parameter in any request.
+        The ID of the message. This ID is only used for tracing and debugging purposes and isn't used as a parameter in any request.
 
 
         :param id: The id of this GetMessage.
@@ -98,7 +105,7 @@ class GetMessage(object):
     def content(self):
         """
         **[Required]** Gets the content of this GetMessage.
-        The content of the message
+        The content of the message.
 
 
         :return: The content of this GetMessage.
@@ -110,7 +117,7 @@ class GetMessage(object):
     def content(self, content):
         """
         Sets the content of this GetMessage.
-        The content of the message
+        The content of the message.
 
 
         :param content: The content of this GetMessage.
@@ -148,7 +155,7 @@ class GetMessage(object):
     def delivery_count(self):
         """
         **[Required]** Gets the delivery_count of this GetMessage.
-        The number of time the message has been delivered to a consumer.
+        The number of times that the message has been delivered to a consumer.
 
 
         :return: The delivery_count of this GetMessage.
@@ -160,7 +167,7 @@ class GetMessage(object):
     def delivery_count(self, delivery_count):
         """
         Sets the delivery_count of this GetMessage.
-        The number of time the message has been delivered to a consumer.
+        The number of times that the message has been delivered to a consumer.
 
 
         :param delivery_count: The delivery_count of this GetMessage.
@@ -172,7 +179,11 @@ class GetMessage(object):
     def visible_after(self):
         """
         **[Required]** Gets the visible_after of this GetMessage.
-        The time after which the message will be visible to other consumers. An RFC3339 formatted datetime string
+        The time after which the message will be visible to other consumers, expressed in `RFC 3339`__ timestamp format.
+
+        Example: `2018-04-20T00:00:07.405Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :return: The visible_after of this GetMessage.
@@ -184,7 +195,11 @@ class GetMessage(object):
     def visible_after(self, visible_after):
         """
         Sets the visible_after of this GetMessage.
-        The time after which the message will be visible to other consumers. An RFC3339 formatted datetime string
+        The time after which the message will be visible to other consumers, expressed in `RFC 3339`__ timestamp format.
+
+        Example: `2018-04-20T00:00:07.405Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :param visible_after: The visible_after of this GetMessage.
@@ -196,7 +211,11 @@ class GetMessage(object):
     def expire_after(self):
         """
         **[Required]** Gets the expire_after of this GetMessage.
-        The time after which the message will be automatically deleted. An RFC3339 formatted datetime string
+        The time after which the message will be automatically deleted, expressed in `RFC 3339`__ timestamp format.
+
+        Example: `2018-04-20T00:00:07.405Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :return: The expire_after of this GetMessage.
@@ -208,7 +227,11 @@ class GetMessage(object):
     def expire_after(self, expire_after):
         """
         Sets the expire_after of this GetMessage.
-        The time after which the message will be automatically deleted. An RFC3339 formatted datetime string
+        The time after which the message will be automatically deleted, expressed in `RFC 3339`__ timestamp format.
+
+        Example: `2018-04-20T00:00:07.405Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :param expire_after: The expire_after of this GetMessage.
@@ -216,6 +239,26 @@ class GetMessage(object):
         """
         self._expire_after = expire_after
 
+    @property
+    def metadata(self):
+        """
+        Gets the metadata of this GetMessage.
+
+        :return: The metadata of this GetMessage.
+        :rtype: oci.queue.models.MessageMetadata
+        """
+        return self._metadata
+
+    @metadata.setter
+    def metadata(self, metadata):
+        """
+        Sets the metadata of this GetMessage.
+
+        :param metadata: The metadata of this GetMessage.
+        :type: oci.queue.models.MessageMetadata
+        """
+        self._metadata = metadata
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/queue/models/message_metadata.py

@@ -0,0 +1,103 @@
+# coding: utf-8
+# Copyright (c) 2016, 2023, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20210201
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class MessageMetadata(object):
+    """
+    Object that represents metadata for message.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new MessageMetadata object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param channel_id:
+            The value to assign to the channel_id property of this MessageMetadata.
+        :type channel_id: str
+
+        :param custom_properties:
+            The value to assign to the custom_properties property of this MessageMetadata.
+        :type custom_properties: dict(str, str)
+
+        """
+        self.swagger_types = {
+            'channel_id': 'str',
+            'custom_properties': 'dict(str, str)'
+        }
+
+        self.attribute_map = {
+            'channel_id': 'channelId',
+            'custom_properties': 'customProperties'
+        }
+
+        self._channel_id = None
+        self._custom_properties = None
+
+    @property
+    def channel_id(self):
+        """
+        **[Required]** Gets the channel_id of this MessageMetadata.
+        The channel ID which specifies the channel to publish or retrieve messages.
+
+
+        :return: The channel_id of this MessageMetadata.
+        :rtype: str
+        """
+        return self._channel_id
+
+    @channel_id.setter
+    def channel_id(self, channel_id):
+        """
+        Sets the channel_id of this MessageMetadata.
+        The channel ID which specifies the channel to publish or retrieve messages.
+
+
+        :param channel_id: The channel_id of this MessageMetadata.
+        :type: str
+        """
+        self._channel_id = channel_id
+
+    @property
+    def custom_properties(self):
+        """
+        Gets the custom_properties of this MessageMetadata.
+        Additional message properties
+
+
+        :return: The custom_properties of this MessageMetadata.
+        :rtype: dict(str, str)
+        """
+        return self._custom_properties
+
+    @custom_properties.setter
+    def custom_properties(self, custom_properties):
+        """
+        Sets the custom_properties of this MessageMetadata.
+        Additional message properties
+
+
+        :param custom_properties: The custom_properties of this MessageMetadata.
+        :type: dict(str, str)
+        """
+        self._custom_properties = custom_properties
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/queue/models/purge_queue_details.py

@@ -37,25 +37,32 @@ class PurgeQueueDetails(object):
             Allowed values for this property are: "NORMAL", "DLQ", "BOTH"
         :type purge_type: str
 
+        :param channel_ids:
+            The value to assign to the channel_ids property of this PurgeQueueDetails.
+        :type channel_ids: list[str]
+
         """
         self.swagger_types = {
-            'purge_type': 'str'
+            'purge_type': 'str',
+            'channel_ids': 'list[str]'
         }
 
         self.attribute_map = {
-            'purge_type': 'purgeType'
+            'purge_type': 'purgeType',
+            'channel_ids': 'channelIds'
         }
 
         self._purge_type = None
+        self._channel_ids = None
 
     @property
     def purge_type(self):
         """
         **[Required]** Gets the purge_type of this PurgeQueueDetails.
         Type of the purge to perform:
-        - NORMAL - purge only normal queue
-        - DLQ - purge only DLQ
-        - BOTH - purge both normal queue and DLQ
+        - NORMAL - purge only the normal queue
+        - DLQ - purge only the dead letter queue
+        - BOTH - purge both the normal queue and the dead letter queue
 
         Allowed values for this property are: "NORMAL", "DLQ", "BOTH"
 
@@ -70,9 +77,9 @@ class PurgeQueueDetails(object):
         """
         Sets the purge_type of this PurgeQueueDetails.
         Type of the purge to perform:
-        - NORMAL - purge only normal queue
-        - DLQ - purge only DLQ
-        - BOTH - purge both normal queue and DLQ
+        - NORMAL - purge only the normal queue
+        - DLQ - purge only the dead letter queue
+        - BOTH - purge both the normal queue and the dead letter queue
 
 
         :param purge_type: The purge_type of this PurgeQueueDetails.
@@ -86,6 +93,34 @@ class PurgeQueueDetails(object):
             )
         self._purge_type = purge_type
 
+    @property
+    def channel_ids(self):
+        """
+        Gets the channel_ids of this PurgeQueueDetails.
+        Optional parameter to specify the destination of purge operation.
+        If the channel ID is specified, the purge operation will delete all the messages in the specific channels.
+        If the channel ID is not specified, the purge operation will delete all the messages in the queue and in the child channels.
+
+
+        :return: The channel_ids of this PurgeQueueDetails.
+        :rtype: list[str]
+        """
+        return self._channel_ids
+
+    @channel_ids.setter
+    def channel_ids(self, channel_ids):
+        """
+        Sets the channel_ids of this PurgeQueueDetails.
+        Optional parameter to specify the destination of purge operation.
+        If the channel ID is specified, the purge operation will delete all the messages in the specific channels.
+        If the channel ID is not specified, the purge operation will delete all the messages in the queue and in the child channels.
+
+
+        :param channel_ids: The channel_ids of this PurgeQueueDetails.
+        :type: list[str]
+        """
+        self._channel_ids = channel_ids
+
     def __repr__(self):
         return formatted_flat_dict(self)