NodeSummary¶
- class oci.redis.models.NodeSummary(**kwargs)¶
Bases:
objectThe details of each node in the cluster.
Methods:
__init__(**kwargs)Initializes a new NodeSummary object with values from keyword arguments.
Attributes:
[Required] Gets the display_name of this NodeSummary.
[Required] Gets the private_endpoint_fqdn of this NodeSummary.
[Required] Gets the private_endpoint_ip_address of this NodeSummary.
[Required] Gets the redis_cluster_id of this NodeSummary.
Gets the shard_number of this NodeSummary.
- __init__(**kwargs)¶
Initializes a new NodeSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
private_endpoint_fqdn (str) – The value to assign to the private_endpoint_fqdn property of this NodeSummary.
private_endpoint_ip_address (str) – The value to assign to the private_endpoint_ip_address property of this NodeSummary.
display_name (str) – The value to assign to the display_name property of this NodeSummary.
redis_cluster_id (str) – The value to assign to the redis_cluster_id property of this NodeSummary.
shard_number (int) – The value to assign to the shard_number property of this NodeSummary.
- property display_name¶
[Required] Gets the display_name of this NodeSummary. A user-friendly name of a cluster node.
- Returns
The display_name of this NodeSummary.
- Return type
str
- property private_endpoint_fqdn¶
[Required] Gets the private_endpoint_fqdn of this NodeSummary. The fully qualified domain name (FQDN) of the API endpoint to access a specific node.
- Returns
The private_endpoint_fqdn of this NodeSummary.
- Return type
str
- property private_endpoint_ip_address¶
[Required] Gets the private_endpoint_ip_address of this NodeSummary. The private IP address of the API endpoint to access a specific node.
- Returns
The private_endpoint_ip_address of this NodeSummary.
- Return type
str
- property redis_cluster_id¶
[Required] Gets the redis_cluster_id of this NodeSummary. The OCID of the cluster
- Returns
The redis_cluster_id of this NodeSummary.
- Return type
str
- property shard_number¶
Gets the shard_number of this NodeSummary. The shard number to which the node belongs to.
- Returns
The shard_number of this NodeSummary.
- Return type
int