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

oci/queue/models/update_messages_details.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class UpdateMessagesDetails(object):
     """
-    The details of a UpdateMessages request.
+    The details of an UpdateMessages request.
     """
 
     def __init__(self, **kwargs):

oci/queue/models/update_messages_details_entry.py

@@ -46,7 +46,7 @@ class UpdateMessagesDetailsEntry(object):
     def receipt(self):
         """
         **[Required]** Gets the receipt of this UpdateMessagesDetailsEntry.
-        The receipt of the message to update
+        The receipt of the message to update.
 
 
         :return: The receipt of this UpdateMessagesDetailsEntry.
@@ -58,7 +58,7 @@ class UpdateMessagesDetailsEntry(object):
     def receipt(self, receipt):
         """
         Sets the receipt of this UpdateMessagesDetailsEntry.
-        The receipt of the message to update
+        The receipt of the message to update.
 
 
         :param receipt: The receipt of this UpdateMessagesDetailsEntry.

oci/queue/models/update_messages_result.py

@@ -77,7 +77,7 @@ class UpdateMessagesResult(object):
     def client_failures(self):
         """
         **[Required]** Gets the client_failures of this UpdateMessagesResult.
-        The number of messages that failed to be updated in the queue because of a client failure such as an invalid receipt or invalid visibilityInSeconds.
+        The number of messages that failed to be updated in the queue because of a client failure such as an invalid receipt or invalid `visibilityInSeconds`.
 
 
         :return: The client_failures of this UpdateMessagesResult.
@@ -89,7 +89,7 @@ class UpdateMessagesResult(object):
     def client_failures(self, client_failures):
         """
         Sets the client_failures of this UpdateMessagesResult.
-        The number of messages that failed to be updated in the queue because of a client failure such as an invalid receipt or invalid visibilityInSeconds.
+        The number of messages that failed to be updated in the queue because of a client failure such as an invalid receipt or invalid `visibilityInSeconds`.
 
 
         :param client_failures: The client_failures of this UpdateMessagesResult.

oci/queue/models/update_messages_result_entry.py

@@ -62,7 +62,7 @@ class UpdateMessagesResultEntry(object):
     def id(self):
         """
         Gets the id of this UpdateMessagesResultEntry.
-        The id of the message that's been updated.
+        The ID of the message that's been updated.
 
 
         :return: The id of this UpdateMessagesResultEntry.
@@ -74,7 +74,7 @@ class UpdateMessagesResultEntry(object):
     def id(self, id):
         """
         Sets the id of this UpdateMessagesResultEntry.
-        The id of the message that's been updated.
+        The ID of the message that's been updated.
 
 
         :param id: The id of this UpdateMessagesResultEntry.
@@ -86,7 +86,11 @@ class UpdateMessagesResultEntry(object):
     def visible_after(self):
         """
         Gets the visible_after of this UpdateMessagesResultEntry.
-        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 UpdateMessagesResultEntry.
@@ -98,7 +102,11 @@ class UpdateMessagesResultEntry(object):
     def visible_after(self, visible_after):
         """
         Sets the visible_after of this UpdateMessagesResultEntry.
-        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 UpdateMessagesResultEntry.

oci/queue/models/update_queue_details.py

@@ -32,6 +32,10 @@ class UpdateQueueDetails(object):
             The value to assign to the timeout_in_seconds property of this UpdateQueueDetails.
         :type timeout_in_seconds: int
 
+        :param channel_consumption_limit:
+            The value to assign to the channel_consumption_limit property of this UpdateQueueDetails.
+        :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 UpdateQueueDetails.
         :type dead_letter_queue_delivery_count: int
@@ -53,6 +57,7 @@ class UpdateQueueDetails(object):
             'display_name': 'str',
             '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)',
@@ -63,6 +68,7 @@ class UpdateQueueDetails(object):
             'display_name': 'displayName',
             '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',
@@ -72,6 +78,7 @@ class UpdateQueueDetails(object):
         self._display_name = 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
@@ -81,7 +88,9 @@ class UpdateQueueDetails(object):
     def display_name(self):
         """
         Gets the display_name of this UpdateQueueDetails.
-        Queue Identifier
+        The `OCID`__ of the queue.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
 
         :return: The display_name of this UpdateQueueDetails.
@@ -93,7 +102,9 @@ class UpdateQueueDetails(object):
     def display_name(self, display_name):
         """
         Sets the display_name of this UpdateQueueDetails.
-        Queue Identifier
+        The `OCID`__ of the queue.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
 
         :param display_name: The display_name of this UpdateQueueDetails.
@@ -105,7 +116,7 @@ class UpdateQueueDetails(object):
     def visibility_in_seconds(self):
         """
         Gets the visibility_in_seconds of this UpdateQueueDetails.
-        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 UpdateQueueDetails.
@@ -117,7 +128,7 @@ class UpdateQueueDetails(object):
     def visibility_in_seconds(self, visibility_in_seconds):
         """
         Sets the visibility_in_seconds of this UpdateQueueDetails.
-        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 UpdateQueueDetails.
@@ -149,13 +160,37 @@ class UpdateQueueDetails(object):
         """
         self._timeout_in_seconds = timeout_in_seconds
 
+    @property
+    def channel_consumption_limit(self):
+        """
+        Gets the channel_consumption_limit of this UpdateQueueDetails.
+        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 UpdateQueueDetails.
+        :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 UpdateQueueDetails.
+        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 UpdateQueueDetails.
+        :type: int
+        """
+        self._channel_consumption_limit = channel_consumption_limit
+
     @property
     def dead_letter_queue_delivery_count(self):
         """
         Gets the dead_letter_queue_delivery_count of this UpdateQueueDetails.
         The number of times a message can be delivered to a consumer before being moved to the dead letter queue.
         A value of 0 indicates that the DLQ is not used.
-        Changing that value to a lower threshold does not retro-actively move in-flight messages in the dead letter queue.
+        Changing that value to a lower threshold does not retroactively move in-flight messages in the dead letter queue.
 
 
         :return: The dead_letter_queue_delivery_count of this UpdateQueueDetails.
@@ -169,7 +204,7 @@ class UpdateQueueDetails(object):
         Sets the dead_letter_queue_delivery_count of this UpdateQueueDetails.
         The number of times a message can be delivered to a consumer before being moved to the dead letter queue.
         A value of 0 indicates that the DLQ is not used.
-        Changing that value to a lower threshold does not retro-actively move in-flight messages in the dead letter queue.
+        Changing that value to a lower threshold does not retroactively move in-flight messages in the dead letter queue.
 
 
         :param dead_letter_queue_delivery_count: The dead_letter_queue_delivery_count of this UpdateQueueDetails.
@@ -181,7 +216,9 @@ class UpdateQueueDetails(object):
     def custom_encryption_key_id(self):
         """
         Gets the custom_encryption_key_id of this UpdateQueueDetails.
-        Id of the custom master encryption key which will be used to encrypt messages content. String of length 0 means the custom key should be removed from queue
+        The `OCID`__ of the custom encryption key to be used to encrypt messages content. A string with a length of 0 means the custom key should be removed from queue.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
 
         :return: The custom_encryption_key_id of this UpdateQueueDetails.
@@ -193,7 +230,9 @@ class UpdateQueueDetails(object):
     def custom_encryption_key_id(self, custom_encryption_key_id):
         """
         Sets the custom_encryption_key_id of this UpdateQueueDetails.
-        Id of the custom master encryption key which will be used to encrypt messages content. String of length 0 means the custom key should be removed from queue
+        The `OCID`__ of the custom encryption key to be used to encrypt messages content. A string with a length of 0 means the custom key should be removed from queue.
+
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
 
 
         :param custom_encryption_key_id: The custom_encryption_key_id of this UpdateQueueDetails.

oci/queue/models/updated_message.py

@@ -46,7 +46,7 @@ class UpdatedMessage(object):
     def id(self):
         """
         **[Required]** Gets the id of this UpdatedMessage.
-        The id of the message that's been updated.
+        The ID of the message that's been updated.
 
 
         :return: The id of this UpdatedMessage.
@@ -58,7 +58,7 @@ class UpdatedMessage(object):
     def id(self, id):
         """
         Sets the id of this UpdatedMessage.
-        The id of the message that's been updated.
+        The ID of the message that's been updated.
 
 
         :param id: The id of this UpdatedMessage.
@@ -70,7 +70,11 @@ class UpdatedMessage(object):
     def visible_after(self):
         """
         **[Required]** Gets the visible_after of this UpdatedMessage.
-        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 UpdatedMessage.
@@ -82,7 +86,11 @@ class UpdatedMessage(object):
     def visible_after(self, visible_after):
         """
         Sets the visible_after of this UpdatedMessage.
-        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 UpdatedMessage.

oci/queue/models/work_request.py

@@ -227,11 +227,13 @@ class WorkRequest(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this WorkRequest.
-        The ocid of the compartment that contains the work request. Work requests should be scoped to
+        The `OCID`__ of the compartment that contains the work request. Work requests should be scoped to
         the same compartment as the resource the work request affects. If the work request affects multiple resources,
         and those resources are not in the same compartment, it is up to the service team to pick the primary
         resource whose compartment should be used
 
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
 
         :return: The compartment_id of this WorkRequest.
         :rtype: str
@@ -242,11 +244,13 @@ class WorkRequest(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this WorkRequest.
-        The ocid of the compartment that contains the work request. Work requests should be scoped to
+        The `OCID`__ of the compartment that contains the work request. Work requests should be scoped to
         the same compartment as the resource the work request affects. If the work request affects multiple resources,
         and those resources are not in the same compartment, it is up to the service team to pick the primary
         resource whose compartment should be used
 
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
 
         :param compartment_id: The compartment_id of this WorkRequest.
         :type: str

oci/queue/models/work_request_error.py

@@ -103,7 +103,9 @@ class WorkRequestError(object):
     def timestamp(self):
         """
         **[Required]** Gets the timestamp of this WorkRequestError.
-        The time the error occured. An RFC3339 formatted datetime string.
+        The time the error occured. An `RFC 3339`__ formatted datetime string.
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :return: The timestamp of this WorkRequestError.
@@ -115,7 +117,9 @@ class WorkRequestError(object):
     def timestamp(self, timestamp):
         """
         Sets the timestamp of this WorkRequestError.
-        The time the error occured. An RFC3339 formatted datetime string.
+        The time the error occured. An `RFC 3339`__ formatted datetime string.
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :param timestamp: The timestamp of this WorkRequestError.

oci/queue/models/work_request_log_entry.py

@@ -70,7 +70,9 @@ class WorkRequestLogEntry(object):
     def timestamp(self):
         """
         **[Required]** Gets the timestamp of this WorkRequestLogEntry.
-        The time the log message was written. An RFC3339 formatted datetime string
+        The time the log message was written. An `RFC 3339`__ formatted datetime string
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :return: The timestamp of this WorkRequestLogEntry.
@@ -82,7 +84,9 @@ class WorkRequestLogEntry(object):
     def timestamp(self, timestamp):
         """
         Sets the timestamp of this WorkRequestLogEntry.
-        The time the log message was written. An RFC3339 formatted datetime string
+        The time the log message was written. An `RFC 3339`__ formatted datetime string
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :param timestamp: The timestamp of this WorkRequestLogEntry.

oci/queue/models/work_request_summary.py

@@ -203,7 +203,7 @@ class WorkRequestSummary(object):
     def id(self):
         """
         **[Required]** Gets the id of this WorkRequestSummary.
-        The id of the work request.
+        The ID of the work request.
 
 
         :return: The id of this WorkRequestSummary.
@@ -215,7 +215,7 @@ class WorkRequestSummary(object):
     def id(self, id):
         """
         Sets the id of this WorkRequestSummary.
-        The id of the work request.
+        The ID of the work request.
 
 
         :param id: The id of this WorkRequestSummary.
@@ -227,11 +227,13 @@ class WorkRequestSummary(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this WorkRequestSummary.
-        The ocid of the compartment that contains the work request. Work requests should be scoped to
+        The `OCID`__ of the compartment that contains the work request. Work requests should be scoped to
         the same compartment as the resource the work request affects. If the work request affects multiple resources,
         and those resources are not in the same compartment, it is up to the service team to pick the primary
         resource whose compartment should be used
 
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
 
         :return: The compartment_id of this WorkRequestSummary.
         :rtype: str
@@ -242,11 +244,13 @@ class WorkRequestSummary(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this WorkRequestSummary.
-        The ocid of the compartment that contains the work request. Work requests should be scoped to
+        The `OCID`__ of the compartment that contains the work request. Work requests should be scoped to
         the same compartment as the resource the work request affects. If the work request affects multiple resources,
         and those resources are not in the same compartment, it is up to the service team to pick the primary
         resource whose compartment should be used
 
+        __ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
+
 
         :param compartment_id: The compartment_id of this WorkRequestSummary.
         :type: str