OutboundClusterSummary¶

class oci.opensearch.models.OutboundClusterSummary(**kwargs)¶

Bases: object

Contains details of a Outbound cluster

Attributes

`MODE_REPLICATION_ONLY`	A constant which can be used with the mode property of a OutboundClusterSummary.
`MODE_SEARCH_AND_REPLICATION`	A constant which can be used with the mode property of a OutboundClusterSummary.
`MODE_SEARCH_ONLY`	A constant which can be used with the mode property of a OutboundClusterSummary.
`display_name`	[Required] Gets the display_name of this OutboundClusterSummary.
`is_skip_unavailable`	Gets the is_skip_unavailable of this OutboundClusterSummary.
`mode`	Gets the mode of this OutboundClusterSummary.
`ping_schedule`	Gets the ping_schedule of this OutboundClusterSummary.
`seed_cluster_id`	[Required] Gets the seed_cluster_id of this OutboundClusterSummary.

Methods

__init__(**kwargs) Initializes a new OutboundClusterSummary object with values from keyword arguments.

MODE_REPLICATION_ONLY = 'REPLICATION_ONLY'¶: A constant which can be used with the mode property of a OutboundClusterSummary. This constant has a value of “REPLICATION_ONLY”

MODE_SEARCH_AND_REPLICATION = 'SEARCH_AND_REPLICATION'¶: A constant which can be used with the mode property of a OutboundClusterSummary. This constant has a value of “SEARCH_AND_REPLICATION”

MODE_SEARCH_ONLY = 'SEARCH_ONLY'¶: A constant which can be used with the mode property of a OutboundClusterSummary. This constant has a value of “SEARCH_ONLY”

__init__(**kwargs)¶

Initializes a new OutboundClusterSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

display_name (str) – The value to assign to the display_name property of this OutboundClusterSummary.
ping_schedule (str) – The value to assign to the ping_schedule property of this OutboundClusterSummary.
is_skip_unavailable (bool) – The value to assign to the is_skip_unavailable property of this OutboundClusterSummary.
seed_cluster_id (str) – The value to assign to the seed_cluster_id property of this OutboundClusterSummary.
mode (str) – The value to assign to the mode property of this OutboundClusterSummary. Allowed values for this property are: “SEARCH_ONLY”, “REPLICATION_ONLY”, “SEARCH_AND_REPLICATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

display_name¶

[Required] Gets the display_name of this OutboundClusterSummary. Name of the Outbound cluster. Avoid entering confidential information.

Returns:	The display_name of this OutboundClusterSummary.
Return type:	str

is_skip_unavailable¶

Gets the is_skip_unavailable of this OutboundClusterSummary. Flag to indicate whether to skip the Outbound cluster during cross cluster search, if it is unavailable

Returns:	The is_skip_unavailable of this OutboundClusterSummary.
Return type:	bool

mode¶

Gets the mode of this OutboundClusterSummary. Mode for the cross cluster connection

Allowed values for this property are: “SEARCH_ONLY”, “REPLICATION_ONLY”, “SEARCH_AND_REPLICATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The mode of this OutboundClusterSummary.
Return type:	str

ping_schedule¶

Gets the ping_schedule of this OutboundClusterSummary. Sets the time interval between regular application-level ping messages that are sent to try and keep outbound cluster connections alive. If set to -1, application-level ping messages to this outbound cluster are not sent. If unset, application-level ping messages are sent according to the global transport.ping_schedule setting, which defaults to -1 meaning that pings are not sent.

Returns:	The ping_schedule of this OutboundClusterSummary.
Return type:	str

seed_cluster_id¶

[Required] Gets the seed_cluster_id of this OutboundClusterSummary. OCID of the Outbound cluster

Returns:	The seed_cluster_id of this OutboundClusterSummary.
Return type:	str