OpensearchClusterPipelineSummary¶
-
class
oci.opensearch.models.
OpensearchClusterPipelineSummary
(**kwargs)¶ Bases:
object
The summary of information about an OpenSearch cluster Pipeline.
Methods
__init__
(**kwargs)Initializes a new OpensearchClusterPipelineSummary object with values from keyword arguments. Attributes
compartment_id
[Required] Gets the compartment_id of this OpensearchClusterPipelineSummary. data_prepper_configuration_body
[Required] Gets the data_prepper_configuration_body of this OpensearchClusterPipelineSummary. defined_tags
Gets the defined_tags of this OpensearchClusterPipelineSummary. display_name
[Required] Gets the display_name of this OpensearchClusterPipelineSummary. freeform_tags
Gets the freeform_tags of this OpensearchClusterPipelineSummary. id
[Required] Gets the id of this OpensearchClusterPipelineSummary. lifecycle_state
[Required] Gets the lifecycle_state of this OpensearchClusterPipelineSummary. memory_gb
[Required] Gets the memory_gb of this OpensearchClusterPipelineSummary. node_count
[Required] Gets the node_count of this OpensearchClusterPipelineSummary. ocpu_count
[Required] Gets the ocpu_count of this OpensearchClusterPipelineSummary. pipeline_configuration_body
[Required] Gets the pipeline_configuration_body of this OpensearchClusterPipelineSummary. pipeline_mode
[Required] Gets the pipeline_mode of this OpensearchClusterPipelineSummary. subnet_id
Gets the subnet_id of this OpensearchClusterPipelineSummary. system_tags
Gets the system_tags of this OpensearchClusterPipelineSummary. time_created
Gets the time_created of this OpensearchClusterPipelineSummary. time_updated
Gets the time_updated of this OpensearchClusterPipelineSummary. vcn_id
Gets the vcn_id of this OpensearchClusterPipelineSummary. -
__init__
(**kwargs)¶ Initializes a new OpensearchClusterPipelineSummary 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 OpensearchClusterPipelineSummary.
- display_name (str) – The value to assign to the display_name property of this OpensearchClusterPipelineSummary.
- compartment_id (str) – The value to assign to the compartment_id property of this OpensearchClusterPipelineSummary.
- vcn_id (str) – The value to assign to the vcn_id property of this OpensearchClusterPipelineSummary.
- subnet_id (str) – The value to assign to the subnet_id property of this OpensearchClusterPipelineSummary.
- ocpu_count (int) – The value to assign to the ocpu_count property of this OpensearchClusterPipelineSummary.
- memory_gb (int) – The value to assign to the memory_gb property of this OpensearchClusterPipelineSummary.
- node_count (int) – The value to assign to the node_count property of this OpensearchClusterPipelineSummary.
- pipeline_configuration_body (str) – The value to assign to the pipeline_configuration_body property of this OpensearchClusterPipelineSummary.
- data_prepper_configuration_body (str) – The value to assign to the data_prepper_configuration_body property of this OpensearchClusterPipelineSummary.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this OpensearchClusterPipelineSummary.
- pipeline_mode (str) – The value to assign to the pipeline_mode property of this OpensearchClusterPipelineSummary.
- time_created (datetime) – The value to assign to the time_created property of this OpensearchClusterPipelineSummary.
- time_updated (datetime) – The value to assign to the time_updated property of this OpensearchClusterPipelineSummary.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OpensearchClusterPipelineSummary.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OpensearchClusterPipelineSummary.
- system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OpensearchClusterPipelineSummary.
-
compartment_id
¶ [Required] Gets the compartment_id of this OpensearchClusterPipelineSummary. The OCID of the compartment where the cluster pipeline is located.
Returns: The compartment_id of this OpensearchClusterPipelineSummary. Return type: str
-
data_prepper_configuration_body
¶ [Required] Gets the data_prepper_configuration_body of this OpensearchClusterPipelineSummary. 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 OpensearchClusterPipelineSummary. Return type: str
Gets the defined_tags of this OpensearchClusterPipelineSummary. 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 OpensearchClusterPipelineSummary. Return type: dict(str, dict(str, object))
-
display_name
¶ [Required] Gets the display_name of this OpensearchClusterPipelineSummary. The name of the cluster pipeline. Avoid entering confidential information.
Returns: The display_name of this OpensearchClusterPipelineSummary. Return type: str
Gets the freeform_tags of this OpensearchClusterPipelineSummary. 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 OpensearchClusterPipelineSummary. Return type: dict(str, str)
-
id
¶ [Required] Gets the id of this OpensearchClusterPipelineSummary. The OCID of the cluster pipeline.
Returns: The id of this OpensearchClusterPipelineSummary. Return type: str
-
lifecycle_state
¶ [Required] Gets the lifecycle_state of this OpensearchClusterPipelineSummary. The current state of the cluster pipeline.
Returns: The lifecycle_state of this OpensearchClusterPipelineSummary. Return type: str
-
memory_gb
¶ [Required] Gets the memory_gb of this OpensearchClusterPipelineSummary. The amount of memory in GB, for each pipeline node.
Returns: The memory_gb of this OpensearchClusterPipelineSummary. Return type: int
-
node_count
¶ [Required] Gets the node_count of this OpensearchClusterPipelineSummary. The number of nodes configured for the pipeline.
Returns: The node_count of this OpensearchClusterPipelineSummary. Return type: int
-
ocpu_count
¶ [Required] Gets the ocpu_count of this OpensearchClusterPipelineSummary. The number of OCPUs configured for each pipeline node.
Returns: The ocpu_count of this OpensearchClusterPipelineSummary. Return type: int
-
pipeline_configuration_body
¶ [Required] Gets the pipeline_configuration_body of this OpensearchClusterPipelineSummary. 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 OpensearchClusterPipelineSummary. Return type: str
-
pipeline_mode
¶ [Required] Gets the pipeline_mode of this OpensearchClusterPipelineSummary. The current state of the pipeline.
Returns: The pipeline_mode of this OpensearchClusterPipelineSummary. Return type: str
-
subnet_id
¶ Gets the subnet_id of this OpensearchClusterPipelineSummary. The OCID of the pipeline’s subnet.
Returns: The subnet_id of this OpensearchClusterPipelineSummary. Return type: str
Gets the system_tags of this OpensearchClusterPipelineSummary. 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 OpensearchClusterPipelineSummary. Return type: dict(str, dict(str, object))
-
time_created
¶ Gets the time_created of this OpensearchClusterPipelineSummary. The date and time the cluster pipeline was created. Format defined by RFC3339.
Returns: The time_created of this OpensearchClusterPipelineSummary. Return type: datetime
-
time_updated
¶ Gets the time_updated of this OpensearchClusterPipelineSummary. The date and time the cluster pipeline was updated. Format defined by RFC3339.
Returns: The time_updated of this OpensearchClusterPipelineSummary. Return type: datetime
-
vcn_id
¶ Gets the vcn_id of this OpensearchClusterPipelineSummary. The OCID of the pipeline’s VCN.
Returns: The vcn_id of this OpensearchClusterPipelineSummary. Return type: str
-