OpensearchClusterPipeline¶

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

Bases: object

An OpenSearch cluster Pipeline resource. An cluster is set of instances that provide OpenSearch functionality in OCI Search Service with OpenSearch. For more information, see Cluster Pipelines.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a OpensearchClusterPipeline.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a OpensearchClusterPipeline.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a OpensearchClusterPipeline.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a OpensearchClusterPipeline.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a OpensearchClusterPipeline.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a OpensearchClusterPipeline.
`PIPELINE_MODE_RUNNING`	A constant which can be used with the pipeline_mode property of a OpensearchClusterPipeline.
`PIPELINE_MODE_STOPPED`	A constant which can be used with the pipeline_mode property of a OpensearchClusterPipeline.
`compartment_id`	[Required] Gets the compartment_id of this OpensearchClusterPipeline.
`data_prepper_configuration_body`	[Required] Gets the data_prepper_configuration_body of this OpensearchClusterPipeline.
`defined_tags`	Gets the defined_tags of this OpensearchClusterPipeline.
`display_name`	[Required] Gets the display_name of this OpensearchClusterPipeline.
`freeform_tags`	Gets the freeform_tags of this OpensearchClusterPipeline.
`id`	[Required] Gets the id of this OpensearchClusterPipeline.
`lifecycle_state`	[Required] Gets the lifecycle_state of this OpensearchClusterPipeline.
`memory_gb`	[Required] Gets the memory_gb of this OpensearchClusterPipeline.
`node_count`	[Required] Gets the node_count of this OpensearchClusterPipeline.
`nsg_id`	Gets the nsg_id of this OpensearchClusterPipeline.
`ocpu_count`	[Required] Gets the ocpu_count of this OpensearchClusterPipeline.
`opensearch_pipeline_fqdn`	[Required] Gets the opensearch_pipeline_fqdn of this OpensearchClusterPipeline.
`opensearch_pipeline_private_ip`	[Required] Gets the opensearch_pipeline_private_ip of this OpensearchClusterPipeline.
`pipeline_configuration_body`	[Required] Gets the pipeline_configuration_body of this OpensearchClusterPipeline.
`pipeline_mode`	[Required] Gets the pipeline_mode of this OpensearchClusterPipeline.
`reverse_connection_endpoints`	Gets the reverse_connection_endpoints of this OpensearchClusterPipeline.
`subnet_compartment_id`	[Required] Gets the subnet_compartment_id of this OpensearchClusterPipeline.
`subnet_id`	[Required] Gets the subnet_id of this OpensearchClusterPipeline.
`system_tags`	Gets the system_tags of this OpensearchClusterPipeline.
`time_created`	Gets the time_created of this OpensearchClusterPipeline.
`time_updated`	Gets the time_updated of this OpensearchClusterPipeline.
`vcn_compartment_id`	[Required] Gets the vcn_compartment_id of this OpensearchClusterPipeline.
`vcn_id`	[Required] Gets the vcn_id of this OpensearchClusterPipeline.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a OpensearchClusterPipeline. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a OpensearchClusterPipeline. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a OpensearchClusterPipeline. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a OpensearchClusterPipeline. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a OpensearchClusterPipeline. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a OpensearchClusterPipeline. This constant has a value of “UPDATING”

PIPELINE_MODE_RUNNING = 'RUNNING'¶: A constant which can be used with the pipeline_mode property of a OpensearchClusterPipeline. This constant has a value of “RUNNING”

PIPELINE_MODE_STOPPED = 'STOPPED'¶: A constant which can be used with the pipeline_mode property of a OpensearchClusterPipeline. This constant has a value of “STOPPED”

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this OpensearchClusterPipeline.
display_name (str) – The value to assign to the display_name property of this OpensearchClusterPipeline.
compartment_id (str) – The value to assign to the compartment_id property of this OpensearchClusterPipeline.
vcn_id (str) – The value to assign to the vcn_id property of this OpensearchClusterPipeline.
subnet_id (str) – The value to assign to the subnet_id property of this OpensearchClusterPipeline.
vcn_compartment_id (str) – The value to assign to the vcn_compartment_id property of this OpensearchClusterPipeline.
subnet_compartment_id (str) – The value to assign to the subnet_compartment_id property of this OpensearchClusterPipeline.
ocpu_count (int) – The value to assign to the ocpu_count property of this OpensearchClusterPipeline.
memory_gb (int) – The value to assign to the memory_gb property of this OpensearchClusterPipeline.
node_count (int) – The value to assign to the node_count property of this OpensearchClusterPipeline.
pipeline_configuration_body (str) – The value to assign to the pipeline_configuration_body property of this OpensearchClusterPipeline.
data_prepper_configuration_body (str) – The value to assign to the data_prepper_configuration_body property of this OpensearchClusterPipeline.
opensearch_pipeline_fqdn (str) – The value to assign to the opensearch_pipeline_fqdn property of this OpensearchClusterPipeline.
opensearch_pipeline_private_ip (str) – The value to assign to the opensearch_pipeline_private_ip property of this OpensearchClusterPipeline.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OpensearchClusterPipeline. 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’.
pipeline_mode (str) – The value to assign to the pipeline_mode property of this OpensearchClusterPipeline. Allowed values for this property are: “RUNNING”, “STOPPED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this OpensearchClusterPipeline.
time_updated (datetime) – The value to assign to the time_updated property of this OpensearchClusterPipeline.
reverse_connection_endpoints (list[oci.opensearch.models.OpensearchPipelineReverseConnectionEndpoint]) – The value to assign to the reverse_connection_endpoints property of this OpensearchClusterPipeline.
nsg_id (str) – The value to assign to the nsg_id property of this OpensearchClusterPipeline.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OpensearchClusterPipeline.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OpensearchClusterPipeline.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OpensearchClusterPipeline.

compartment_id¶

[Required] Gets the compartment_id of this OpensearchClusterPipeline. The OCID of the compartment where the pipeline is located.

Returns:	The compartment_id of this OpensearchClusterPipeline.
Return type:	str

data_prepper_configuration_body¶

[Required] Gets the data_prepper_configuration_body of this OpensearchClusterPipeline. The data prepper config in YAML format. The command accepts the data prepper config as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with .

Returns:	The data_prepper_configuration_body of this OpensearchClusterPipeline.
Return type:	str

defined_tags¶

Gets the defined_tags of this OpensearchClusterPipeline. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this OpensearchClusterPipeline.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this OpensearchClusterPipeline. The name of the pipeline. Avoid entering confidential information.

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

freeform_tags¶

Gets the freeform_tags of this OpensearchClusterPipeline. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this OpensearchClusterPipeline.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this OpensearchClusterPipeline. The OCID of the cluster pipeline.

Returns:	The id of this OpensearchClusterPipeline.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this OpensearchClusterPipeline. The current state of the cluster backup.

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’.

Returns:	The lifecycle_state of this OpensearchClusterPipeline.
Return type:	str

memory_gb¶

[Required] Gets the memory_gb of this OpensearchClusterPipeline. The amount of memory in GB, for each pipeline node.

Returns:	The memory_gb of this OpensearchClusterPipeline.
Return type:	int

node_count¶

[Required] Gets the node_count of this OpensearchClusterPipeline. The number of nodes configured for the pipeline.

Returns:	The node_count of this OpensearchClusterPipeline.
Return type:	int

nsg_id¶

Gets the nsg_id of this OpensearchClusterPipeline. The OCID of the NSG where the pipeline private endpoint vnic will be attached.

Returns:	The nsg_id of this OpensearchClusterPipeline.
Return type:	str

ocpu_count¶

[Required] Gets the ocpu_count of this OpensearchClusterPipeline. The number of OCPUs configured for each pipeline node.

Returns:	The ocpu_count of this OpensearchClusterPipeline.
Return type:	int

opensearch_pipeline_fqdn¶

[Required] Gets the opensearch_pipeline_fqdn of this OpensearchClusterPipeline. The fully qualified domain name (FQDN) for the cluster’s API endpoint.

Returns:	The opensearch_pipeline_fqdn of this OpensearchClusterPipeline.
Return type:	str

opensearch_pipeline_private_ip¶

[Required] Gets the opensearch_pipeline_private_ip of this OpensearchClusterPipeline. The pipeline’s private IP address.

Returns:	The opensearch_pipeline_private_ip of this OpensearchClusterPipeline.
Return type:	str

pipeline_configuration_body¶

[Required] Gets the pipeline_configuration_body of this OpensearchClusterPipeline. The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with .

Returns:	The pipeline_configuration_body of this OpensearchClusterPipeline.
Return type:	str

pipeline_mode¶

[Required] Gets the pipeline_mode of this OpensearchClusterPipeline. The current state of the pipeline.

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

Returns:	The pipeline_mode of this OpensearchClusterPipeline.
Return type:	str

reverse_connection_endpoints¶

Gets the reverse_connection_endpoints of this OpensearchClusterPipeline. The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.

Returns:	The reverse_connection_endpoints of this OpensearchClusterPipeline.
Return type:	list[oci.opensearch.models.OpensearchPipelineReverseConnectionEndpoint]

subnet_compartment_id¶

[Required] Gets the subnet_compartment_id of this OpensearchClusterPipeline. The OCID for the compartment where the pipeline’s subnet is located.

Returns:	The subnet_compartment_id of this OpensearchClusterPipeline.
Return type:	str

subnet_id¶

[Required] Gets the subnet_id of this OpensearchClusterPipeline. The OCID of the pipeline’s subnet.

Returns:	The subnet_id of this OpensearchClusterPipeline.
Return type:	str

system_tags¶

Gets the system_tags of this OpensearchClusterPipeline. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this OpensearchClusterPipeline.
Return type:	dict(str, dict(str, object))

time_created¶

Gets the time_created of this OpensearchClusterPipeline. The date and time the cluster pipeline was created. Format defined by RFC3339.

Returns:	The time_created of this OpensearchClusterPipeline.
Return type:	datetime

time_updated¶

Gets the time_updated of this OpensearchClusterPipeline. The amount of time in milliseconds since the pipeline was updated.

Returns:	The time_updated of this OpensearchClusterPipeline.
Return type:	datetime

vcn_compartment_id¶

[Required] Gets the vcn_compartment_id of this OpensearchClusterPipeline. The OCID for the compartment where the pipeline’s VCN is located.

Returns:	The vcn_compartment_id of this OpensearchClusterPipeline.
Return type:	str

vcn_id¶

[Required] Gets the vcn_id of this OpensearchClusterPipeline. The OCID of the pipeline’s VCN.

Returns:	The vcn_id of this OpensearchClusterPipeline.
Return type:	str