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

oci/queue/models/put_message.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class PutMessage(object):
     """
-    A message that has been published in a queue.
+    A message that has been published to a queue.
     """
 
     def __init__(self, **kwargs):
@@ -24,22 +24,29 @@ class PutMessage(object):
             The value to assign to the id property of this PutMessage.
         :type id: int
 
+        :param expire_after:
+            The value to assign to the expire_after property of this PutMessage.
+        :type expire_after: datetime
+
         """
         self.swagger_types = {
-            'id': 'int'
+            'id': 'int',
+            'expire_after': 'datetime'
         }
 
         self.attribute_map = {
-            'id': 'id'
+            'id': 'id',
+            'expire_after': 'expireAfter'
         }
 
         self._id = None
+        self._expire_after = None
 
     @property
     def id(self):
         """
         **[Required]** Gets the id of this PutMessage.
-        The id of the message
+        The ID of the message.
 
 
         :return: The id of this PutMessage.
@@ -51,7 +58,7 @@ class PutMessage(object):
     def id(self, id):
         """
         Sets the id of this PutMessage.
-        The id of the message
+        The ID of the message.
 
 
         :param id: The id of this PutMessage.
@@ -59,6 +66,38 @@ class PutMessage(object):
         """
         self._id = id
 
+    @property
+    def expire_after(self):
+        """
+        Gets the expire_after of this PutMessage.
+        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 PutMessage.
+        :rtype: datetime
+        """
+        return self._expire_after
+
+    @expire_after.setter
+    def expire_after(self, expire_after):
+        """
+        Sets the expire_after of this PutMessage.
+        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 PutMessage.
+        :type: datetime
+        """
+        self._expire_after = expire_after
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/queue/models/put_messages.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class PutMessages(object):
     """
-    A list of the messages published in a queue.
+    A list of the messages published to a queue.
     """
 
     def __init__(self, **kwargs):
@@ -39,7 +39,7 @@ class PutMessages(object):
     def messages(self):
         """
         **[Required]** Gets the messages of this PutMessages.
-        The messages that have been published in a queue.
+        The messages that have been published to a queue.
 
 
         :return: The messages of this PutMessages.
@@ -51,7 +51,7 @@ class PutMessages(object):
     def messages(self, messages):
         """
         Sets the messages of this PutMessages.
-        The messages that have been published in a queue.
+        The messages that have been published to a queue.
 
 
         :param messages: The messages of this PutMessages.

oci/queue/models/put_messages_details_entry.py

@@ -24,16 +24,23 @@ class PutMessagesDetailsEntry(object):
             The value to assign to the content property of this PutMessagesDetailsEntry.
         :type content: str
 
+        :param metadata:
+            The value to assign to the metadata property of this PutMessagesDetailsEntry.
+        :type metadata: oci.queue.models.MessageMetadata
+
         """
         self.swagger_types = {
-            'content': 'str'
+            'content': 'str',
+            'metadata': 'MessageMetadata'
         }
 
         self.attribute_map = {
-            'content': 'content'
+            'content': 'content',
+            'metadata': 'metadata'
         }
 
         self._content = None
+        self._metadata = None
 
     @property
     def content(self):
@@ -59,6 +66,26 @@ class PutMessagesDetailsEntry(object):
         """
         self._content = content
 
+    @property
+    def metadata(self):
+        """
+        Gets the metadata of this PutMessagesDetailsEntry.
+
+        :return: The metadata of this PutMessagesDetailsEntry.
+        :rtype: oci.queue.models.MessageMetadata
+        """
+        return self._metadata
+
+    @metadata.setter
+    def metadata(self, metadata):
+        """
+        Sets the metadata of this PutMessagesDetailsEntry.
+
+        :param metadata: The metadata of this PutMessagesDetailsEntry.
+        :type: oci.queue.models.MessageMetadata
+        """
+        self._metadata = metadata
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/queue/models/queue.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class Queue(object):
     """
-    Description of Queue.
+    A detailed representation of a queue and its configuration.
     """
 
     #: A constant which can be used with the lifecycle_state property of a Queue.
@@ -110,6 +110,10 @@ class Queue(object):
             The value to assign to the system_tags property of this Queue.
         :type system_tags: dict(str, dict(str, object))
 
+        :param channel_consumption_limit:
+            The value to assign to the channel_consumption_limit property of this Queue.
+        :type channel_consumption_limit: int
+
         """
         self.swagger_types = {
             'id': 'str',
@@ -127,7 +131,8 @@ class Queue(object):
             'custom_encryption_key_id': 'str',
             'freeform_tags': 'dict(str, str)',
             'defined_tags': 'dict(str, dict(str, object))',
-            'system_tags': 'dict(str, dict(str, object))'
+            'system_tags': 'dict(str, dict(str, object))',
+            'channel_consumption_limit': 'int'
         }
 
         self.attribute_map = {
@@ -146,7 +151,8 @@ class Queue(object):
             'custom_encryption_key_id': 'customEncryptionKeyId',
             'freeform_tags': 'freeformTags',
             'defined_tags': 'definedTags',
-            'system_tags': 'systemTags'
+            'system_tags': 'systemTags',
+            'channel_consumption_limit': 'channelConsumptionLimit'
         }
 
         self._id = None
@@ -165,12 +171,13 @@ class Queue(object):
         self._freeform_tags = None
         self._defined_tags = None
         self._system_tags = None
+        self._channel_consumption_limit = None
 
     @property
     def id(self):
         """
         **[Required]** Gets the id of this Queue.
-        Unique identifier that is immutable on creation
+        A unique identifier for the queue that is immutable on creation.
 
 
         :return: The id of this Queue.
@@ -182,7 +189,7 @@ class Queue(object):
     def id(self, id):
         """
         Sets the id of this Queue.
-        Unique identifier that is immutable on creation
+        A unique identifier for the queue that is immutable on creation.
 
 
         :param id: The id of this Queue.
@@ -194,7 +201,7 @@ class Queue(object):
     def display_name(self):
         """
         Gets the display_name of this Queue.
-        Queue Identifier, can be renamed
+        A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.
 
 
         :return: The display_name of this Queue.
@@ -206,7 +213,7 @@ class Queue(object):
     def display_name(self, display_name):
         """
         Sets the display_name of this Queue.
-        Queue Identifier, can be renamed
+        A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.
 
 
         :param display_name: The display_name of this Queue.
@@ -218,7 +225,9 @@ class Queue(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this Queue.
-        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 Queue.
@@ -230,7 +239,9 @@ class Queue(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this Queue.
-        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 Queue.
@@ -242,7 +253,11 @@ class Queue(object):
     def time_created(self):
         """
         **[Required]** Gets the time_created of this Queue.
-        The time the the Queue was created. An RFC3339 formatted datetime string
+        The time that the queue was created, expressed in `RFC 3339`__ timestamp format.
+
+        Example: `2018-04-20T00:00:07.405Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :return: The time_created of this Queue.
@@ -254,7 +269,11 @@ class Queue(object):
     def time_created(self, time_created):
         """
         Sets the time_created of this Queue.
-        The time the the Queue was created. An RFC3339 formatted datetime string
+        The time that the queue was created, expressed in `RFC 3339`__ timestamp format.
+
+        Example: `2018-04-20T00:00:07.405Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :param time_created: The time_created of this Queue.
@@ -266,7 +285,11 @@ class Queue(object):
     def time_updated(self):
         """
         **[Required]** Gets the time_updated of this Queue.
-        The time the Queue was updated. An RFC3339 formatted datetime string
+        The time that the queue was updated, expressed in `RFC 3339`__ timestamp format.
+
+        Example: `2018-04-20T00:00:07.405Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :return: The time_updated of this Queue.
@@ -278,7 +301,11 @@ class Queue(object):
     def time_updated(self, time_updated):
         """
         Sets the time_updated of this Queue.
-        The time the Queue was updated. An RFC3339 formatted datetime string
+        The time that the queue was updated, expressed in `RFC 3339`__ timestamp format.
+
+        Example: `2018-04-20T00:00:07.405Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :param time_updated: The time_updated of this Queue.
@@ -290,7 +317,7 @@ class Queue(object):
     def lifecycle_state(self):
         """
         **[Required]** Gets the lifecycle_state of this Queue.
-        The current state of the Queue.
+        The current state of the queue.
 
         Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
@@ -305,7 +332,7 @@ class Queue(object):
     def lifecycle_state(self, lifecycle_state):
         """
         Sets the lifecycle_state of this Queue.
-        The current state of the Queue.
+        The current state of the queue.
 
 
         :param lifecycle_state: The lifecycle_state of this Queue.
@@ -320,7 +347,7 @@ class Queue(object):
     def lifecycle_details(self):
         """
         Gets the lifecycle_details of this Queue.
-        A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
+        Any additional details about the current state of the queue.
 
 
         :return: The lifecycle_details of this Queue.
@@ -332,7 +359,7 @@ class Queue(object):
     def lifecycle_details(self, lifecycle_details):
         """
         Sets the lifecycle_details of this Queue.
-        A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
+        Any additional details about the current state of the queue.
 
 
         :param lifecycle_details: The lifecycle_details of this Queue.
@@ -392,7 +419,7 @@ class Queue(object):
     def visibility_in_seconds(self):
         """
         **[Required]** Gets the visibility_in_seconds of this Queue.
-        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 Queue.
@@ -404,7 +431,7 @@ class Queue(object):
     def visibility_in_seconds(self, visibility_in_seconds):
         """
         Sets the visibility_in_seconds of this Queue.
-        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 Queue.
@@ -464,7 +491,9 @@ class Queue(object):
     def custom_encryption_key_id(self):
         """
         Gets the custom_encryption_key_id of this Queue.
-        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 Queue.
@@ -476,7 +505,9 @@ class Queue(object):
     def custom_encryption_key_id(self, custom_encryption_key_id):
         """
         Sets the custom_encryption_key_id of this Queue.
-        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 Queue.
@@ -562,6 +593,30 @@ class Queue(object):
         """
         self._system_tags = system_tags
 
+    @property
+    def channel_consumption_limit(self):
+        """
+        Gets the channel_consumption_limit of this Queue.
+        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 Queue.
+        :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 Queue.
+        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 Queue.
+        :type: int
+        """
+        self._channel_consumption_limit = channel_consumption_limit
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/queue/models/queue_stats.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class QueueStats(object):
     """
-    The stats for a queue and its dead letter queue.
+    The stats for a queue and its dead letter queue. If channelId is specified in request field, it will return channel specific stats response.
     """
 
     def __init__(self, **kwargs):
@@ -28,19 +28,26 @@ class QueueStats(object):
             The value to assign to the dlq property of this QueueStats.
         :type dlq: oci.queue.models.Stats
 
+        :param channel_id:
+            The value to assign to the channel_id property of this QueueStats.
+        :type channel_id: str
+
         """
         self.swagger_types = {
             'queue': 'Stats',
-            'dlq': 'Stats'
+            'dlq': 'Stats',
+            'channel_id': 'str'
         }
 
         self.attribute_map = {
             'queue': 'queue',
-            'dlq': 'dlq'
+            'dlq': 'dlq',
+            'channel_id': 'channelId'
         }
 
         self._queue = None
         self._dlq = None
+        self._channel_id = None
 
     @property
     def queue(self):
@@ -82,6 +89,30 @@ class QueueStats(object):
         """
         self._dlq = dlq
 
+    @property
+    def channel_id(self):
+        """
+        Gets the channel_id of this QueueStats.
+        If channelId is presented in GetStats call, the channel id will be returned in the GetStats response.
+
+
+        :return: The channel_id of this QueueStats.
+        :rtype: str
+        """
+        return self._channel_id
+
+    @channel_id.setter
+    def channel_id(self, channel_id):
+        """
+        Sets the channel_id of this QueueStats.
+        If channelId is presented in GetStats call, the channel id will be returned in the GetStats response.
+
+
+        :param channel_id: The channel_id of this QueueStats.
+        :type: str
+        """
+        self._channel_id = channel_id
+
     def __repr__(self):
         return formatted_flat_dict(self)
 

oci/queue/models/queue_summary.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class QueueSummary(object):
     """
-    Summary of the Queue.
+    Summary of the queue.
     """
 
     def __init__(self, **kwargs):
@@ -109,7 +109,7 @@ class QueueSummary(object):
     def id(self):
         """
         **[Required]** Gets the id of this QueueSummary.
-        Unique identifier that is immutable on creation
+        A unique identifier for the queue that is immutable on creation.
 
 
         :return: The id of this QueueSummary.
@@ -121,7 +121,7 @@ class QueueSummary(object):
     def id(self, id):
         """
         Sets the id of this QueueSummary.
-        Unique identifier that is immutable on creation
+        A unique identifier for the queue that is immutable on creation.
 
 
         :param id: The id of this QueueSummary.
@@ -133,7 +133,7 @@ class QueueSummary(object):
     def display_name(self):
         """
         Gets the display_name of this QueueSummary.
-        Queue Identifier, can be renamed
+        A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.
 
 
         :return: The display_name of this QueueSummary.
@@ -145,7 +145,7 @@ class QueueSummary(object):
     def display_name(self, display_name):
         """
         Sets the display_name of this QueueSummary.
-        Queue Identifier, can be renamed
+        A user-friendly name for the queue. Does not have to be unique, and it's changeable. Avoid entering confidential information.
 
 
         :param display_name: The display_name of this QueueSummary.
@@ -157,7 +157,9 @@ class QueueSummary(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this QueueSummary.
-        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 QueueSummary.
@@ -169,7 +171,9 @@ class QueueSummary(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this QueueSummary.
-        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 QueueSummary.
@@ -181,7 +185,11 @@ class QueueSummary(object):
     def time_created(self):
         """
         **[Required]** Gets the time_created of this QueueSummary.
-        The time the the Queue was created. An RFC3339 formatted datetime string
+        The time that the queue was created, expressed in `RFC 3339`__ timestamp format.
+
+        Example: `2018-04-20T00:00:07.405Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :return: The time_created of this QueueSummary.
@@ -193,7 +201,11 @@ class QueueSummary(object):
     def time_created(self, time_created):
         """
         Sets the time_created of this QueueSummary.
-        The time the the Queue was created. An RFC3339 formatted datetime string
+        The time that the queue was created, expressed in `RFC 3339`__ timestamp format.
+
+        Example: `2018-04-20T00:00:07.405Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :param time_created: The time_created of this QueueSummary.
@@ -205,7 +217,11 @@ class QueueSummary(object):
     def time_updated(self):
         """
         **[Required]** Gets the time_updated of this QueueSummary.
-        The time the Queue was updated. An RFC3339 formatted datetime string
+        The time that the queue was updated, expressed in `RFC 3339`__ timestamp format.
+
+        Example: `2018-04-20T00:00:07.405Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :return: The time_updated of this QueueSummary.
@@ -217,7 +233,11 @@ class QueueSummary(object):
     def time_updated(self, time_updated):
         """
         Sets the time_updated of this QueueSummary.
-        The time the Queue was updated. An RFC3339 formatted datetime string
+        The time that the queue was updated, expressed in `RFC 3339`__ timestamp format.
+
+        Example: `2018-04-20T00:00:07.405Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :param time_updated: The time_updated of this QueueSummary.
@@ -229,7 +249,7 @@ class QueueSummary(object):
     def lifecycle_state(self):
         """
         **[Required]** Gets the lifecycle_state of this QueueSummary.
-        The current state of the Queue.
+        The current state of the queue.
 
 
         :return: The lifecycle_state of this QueueSummary.
@@ -241,7 +261,7 @@ class QueueSummary(object):
     def lifecycle_state(self, lifecycle_state):
         """
         Sets the lifecycle_state of this QueueSummary.
-        The current state of the Queue.
+        The current state of the queue.
 
 
         :param lifecycle_state: The lifecycle_state of this QueueSummary.
@@ -253,7 +273,7 @@ class QueueSummary(object):
     def lifecycle_details(self):
         """
         Gets the lifecycle_details of this QueueSummary.
-        A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
+        Any additional details about the current state of the queue.
 
 
         :return: The lifecycle_details of this QueueSummary.
@@ -265,7 +285,7 @@ class QueueSummary(object):
     def lifecycle_details(self, lifecycle_details):
         """
         Sets the lifecycle_details of this QueueSummary.
-        A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
+        Any additional details about the current state of the queue.
 
 
         :param lifecycle_details: The lifecycle_details of this QueueSummary.
@@ -277,7 +297,7 @@ class QueueSummary(object):
     def messages_endpoint(self):
         """
         **[Required]** Gets the messages_endpoint of this QueueSummary.
-        The endpoint to use to get or put messages in the queue.
+        The endpoint to use to consume or publish messages in the queue.
 
 
         :return: The messages_endpoint of this QueueSummary.
@@ -289,7 +309,7 @@ class QueueSummary(object):
     def messages_endpoint(self, messages_endpoint):
         """
         Sets the messages_endpoint of this QueueSummary.
-        The endpoint to use to get or put messages in the queue.
+        The endpoint to use to consume or publish messages in the queue.
 
 
         :param messages_endpoint: The messages_endpoint of this QueueSummary.

oci/queue/models/stats.py

@@ -101,7 +101,7 @@ class Stats(object):
     def size_in_bytes(self):
         """
         **[Required]** Gets the size_in_bytes of this Stats.
-        The approximate size of the queue in bytes. Sum of the size of visible of in-flight messages.
+        The approximate size of the queue in bytes. Sum of the size of visible and in-flight messages.
 
 
         :return: The size_in_bytes of this Stats.
@@ -113,7 +113,7 @@ class Stats(object):
     def size_in_bytes(self, size_in_bytes):
         """
         Sets the size_in_bytes of this Stats.
-        The approximate size of the queue in bytes. Sum of the size of visible of in-flight messages.
+        The approximate size of the queue in bytes. Sum of the size of visible and in-flight messages.
 
 
         :param size_in_bytes: The size_in_bytes of this Stats.