File manager

File manager - Edit - /usr/lib/mysqlsh/lib/python3.9/site-packages/oci/queue/models/consumer_group.py

Back
# coding: utf-8 # Copyright (c) 2016, 2026, 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 ConsumerGroup(object): """ A detailed representation of a consumer group. """ #: A constant which can be used with the lifecycle_state property of a ConsumerGroup. #: This constant has a value of "CREATING" LIFECYCLE_STATE_CREATING = "CREATING" #: A constant which can be used with the lifecycle_state property of a ConsumerGroup. #: This constant has a value of "UPDATING" LIFECYCLE_STATE_UPDATING = "UPDATING" #: A constant which can be used with the lifecycle_state property of a ConsumerGroup. #: This constant has a value of "ACTIVE" LIFECYCLE_STATE_ACTIVE = "ACTIVE" #: A constant which can be used with the lifecycle_state property of a ConsumerGroup. #: This constant has a value of "DELETING" LIFECYCLE_STATE_DELETING = "DELETING" #: A constant which can be used with the lifecycle_state property of a ConsumerGroup. #: This constant has a value of "DELETED" LIFECYCLE_STATE_DELETED = "DELETED" #: A constant which can be used with the lifecycle_state property of a ConsumerGroup. #: This constant has a value of "FAILED" LIFECYCLE_STATE_FAILED = "FAILED" #: A constant which can be used with the lifecycle_state property of a ConsumerGroup. #: This constant has a value of "INACTIVE" LIFECYCLE_STATE_INACTIVE = "INACTIVE" def __init__(self, kwargs): """ Initializes a new ConsumerGroup object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class): :param id: The value to assign to the id property of this ConsumerGroup. :type id: str :param display_name: The value to assign to the display_name property of this ConsumerGroup. :type display_name: str :param time_created: The value to assign to the time_created property of this ConsumerGroup. :type time_created: datetime :param time_updated: The value to assign to the time_updated property of this ConsumerGroup. :type time_updated: datetime :param lifecycle_state: The value to assign to the lifecycle_state property of this ConsumerGroup. Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "INACTIVE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :type lifecycle_state: str :param lifecycle_details: The value to assign to the lifecycle_details property of this ConsumerGroup. :type lifecycle_details: str :param filter: The value to assign to the filter property of this ConsumerGroup. :type filter: str :param queue_id: The value to assign to the queue_id property of this ConsumerGroup. :type queue_id: str :param dead_letter_queue_delivery_count: The value to assign to the dead_letter_queue_delivery_count property of this ConsumerGroup. :type dead_letter_queue_delivery_count: int :param freeform_tags: The value to assign to the freeform_tags property of this ConsumerGroup. :type freeform_tags: dict(str, str) :param defined_tags: The value to assign to the defined_tags property of this ConsumerGroup. :type defined_tags: dict(str, dict(str, object)) :param system_tags: The value to assign to the system_tags property of this ConsumerGroup. :type system_tags: dict(str, dict(str, object)) """ self.swagger_types = { 'id': 'str', 'display_name': 'str', 'time_created': 'datetime', 'time_updated': 'datetime', 'lifecycle_state': 'str', 'lifecycle_details': 'str', 'filter': 'str', 'queue_id': 'str', 'dead_letter_queue_delivery_count': 'int', 'freeform_tags': 'dict(str, str)', 'defined_tags': 'dict(str, dict(str, object))', 'system_tags': 'dict(str, dict(str, object))' } self.attribute_map = { 'id': 'id', 'display_name': 'displayName', 'time_created': 'timeCreated', 'time_updated': 'timeUpdated', 'lifecycle_state': 'lifecycleState', 'lifecycle_details': 'lifecycleDetails', 'filter': 'filter', 'queue_id': 'queueId', 'dead_letter_queue_delivery_count': 'deadLetterQueueDeliveryCount', 'freeform_tags': 'freeformTags', 'defined_tags': 'definedTags', 'system_tags': 'systemTags' } self._id = None self._display_name = None self._time_created = None self._time_updated = None self._lifecycle_state = None self._lifecycle_details = None self._filter = None self._queue_id = None self._dead_letter_queue_delivery_count = None self._freeform_tags = None self._defined_tags = None self._system_tags = None @property def id(self): """ [Required] Gets the id of this ConsumerGroup. A unique identifier for the consumer group that is immutable on creation. :return: The id of this ConsumerGroup. :rtype: str """ return self._id @id.setter def id(self, id): """ Sets the id of this ConsumerGroup. A unique identifier for the consumer group that is immutable on creation. :param id: The id of this ConsumerGroup. :type: str """ self._id = id @property def display_name(self): """ [Required] Gets the display_name of this ConsumerGroup. A user-friendly name for the consumer group. It has to be unique within the same queue in a case-insensitive manner. It's changeable. Avoid entering confidential information. :return: The display_name of this ConsumerGroup. :rtype: str """ return self._display_name @display_name.setter def display_name(self, display_name): """ Sets the display_name of this ConsumerGroup. A user-friendly name for the consumer group. It has to be unique within the same queue in a case-insensitive manner. It's changeable. Avoid entering confidential information. :param display_name: The display_name of this ConsumerGroup. :type: str """ self._display_name = display_name @property def time_created(self): """ [Required] Gets the time_created of this ConsumerGroup. The time that the consumer group 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 ConsumerGroup. :rtype: datetime """ return self._time_created @time_created.setter def time_created(self, time_created): """ Sets the time_created of this ConsumerGroup. The time that the consumer group 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 ConsumerGroup. :type: datetime """ self._time_created = time_created @property def time_updated(self): """ [Required] Gets the time_updated of this ConsumerGroup. The time that the consumer group 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 ConsumerGroup. :rtype: datetime """ return self._time_updated @time_updated.setter def time_updated(self, time_updated): """ Sets the time_updated of this ConsumerGroup. The time that the consumer group 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 ConsumerGroup. :type: datetime """ self._time_updated = time_updated @property def lifecycle_state(self): """ [Required] Gets the lifecycle_state of this ConsumerGroup. The current state of the consumer group. Allowed values for this property are: "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "INACTIVE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'. :return: The lifecycle_state of this ConsumerGroup. :rtype: str """ return self._lifecycle_state @lifecycle_state.setter def lifecycle_state(self, lifecycle_state): """ Sets the lifecycle_state of this ConsumerGroup. The current state of the consumer group. :param lifecycle_state: The lifecycle_state of this ConsumerGroup. :type: str """ allowed_values = ["CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "INACTIVE"] if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values): lifecycle_state = 'UNKNOWN_ENUM_VALUE' self._lifecycle_state = lifecycle_state @property def lifecycle_details(self): """ Gets the lifecycle_details of this ConsumerGroup. Any additional details about the current state of the consumer group. :return: The lifecycle_details of this ConsumerGroup. :rtype: str """ return self._lifecycle_details @lifecycle_details.setter def lifecycle_details(self, lifecycle_details): """ Sets the lifecycle_details of this ConsumerGroup. Any additional details about the current state of the consumer group. :param lifecycle_details: The lifecycle_details of this ConsumerGroup. :type: str """ self._lifecycle_details = lifecycle_details @property def filter(self): """ [Required] Gets the filter of this ConsumerGroup. The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. An empty value means that all messages will be available in the group. :return: The filter of this ConsumerGroup. :rtype: str """ return self._filter @filter.setter def filter(self, filter): """ Sets the filter of this ConsumerGroup. The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. An empty value means that all messages will be available in the group. :param filter: The filter of this ConsumerGroup. :type: str """ self._filter = filter @property def queue_id(self): """ [Required]** Gets the queue_id of this ConsumerGroup. The OCID of the associated queue. :return: The queue_id of this ConsumerGroup. :rtype: str """ return self._queue_id @queue_id.setter def queue_id(self, queue_id): """ Sets the queue_id of this ConsumerGroup. The OCID of the associated queue. :param queue_id: The queue_id of this ConsumerGroup. :type: str """ self._queue_id = queue_id @property def dead_letter_queue_delivery_count(self): """ Gets the dead_letter_queue_delivery_count of this ConsumerGroup. 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. If the value isn't set, it will be using the value defined at the queue level. :return: The dead_letter_queue_delivery_count of this ConsumerGroup. :rtype: int """ return self._dead_letter_queue_delivery_count @dead_letter_queue_delivery_count.setter def dead_letter_queue_delivery_count(self, dead_letter_queue_delivery_count): """ Sets the dead_letter_queue_delivery_count of this ConsumerGroup. 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. If the value isn't set, it will be using the value defined at the queue level. :param dead_letter_queue_delivery_count: The dead_letter_queue_delivery_count of this ConsumerGroup. :type: int """ self._dead_letter_queue_delivery_count = dead_letter_queue_delivery_count @property def freeform_tags(self): """ Gets the freeform_tags of this ConsumerGroup. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` :return: The freeform_tags of this ConsumerGroup. :rtype: dict(str, str) """ return self._freeform_tags @freeform_tags.setter def freeform_tags(self, freeform_tags): """ Sets the freeform_tags of this ConsumerGroup. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` :param freeform_tags: The freeform_tags of this ConsumerGroup. :type: dict(str, str) """ self._freeform_tags = freeform_tags @property def defined_tags(self): """ Gets the defined_tags of this ConsumerGroup. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` :return: The defined_tags of this ConsumerGroup. :rtype: dict(str, dict(str, object)) """ return self._defined_tags @defined_tags.setter def defined_tags(self, defined_tags): """ Sets the defined_tags of this ConsumerGroup. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}` :param defined_tags: The defined_tags of this ConsumerGroup. :type: dict(str, dict(str, object)) """ self._defined_tags = defined_tags @property def system_tags(self): """ Gets the system_tags of this ConsumerGroup. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` :return: The system_tags of this ConsumerGroup. :rtype: dict(str, dict(str, object)) """ return self._system_tags @system_tags.setter def system_tags(self, system_tags): """ Sets the system_tags of this ConsumerGroup. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}` :param system_tags: The system_tags of this ConsumerGroup. :type: dict(str, dict(str, object)) """ self._system_tags = system_tags 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

| ver. 1.4 | Github | . | PHP 8.2.32 | Generation time: 0.06 | proxy | phpinfo | Settings