Show / Hide Table of Contents

Namespace Oci.OpensearchService.Models

Classes

BackupEventDetails

Details about a cluster backup event.

BackupOpensearchClusterDetails

Information about an OpenSearch cluster backup.

BackupPolicy

Backup policy as optionally used for Opensearch cluster.

BenchmarkDetails

Benchmark test configuration detail.

ChangeOpensearchClusterBackupCompartmentDetails

Details about the compartment that the cluster backup should move to.

ChangeOpensearchClusterCompartmentDetails

Details about the compartment that the OpenSearch cluster should move to.

ConfigureOutboundClusterDetails

Details for configuring the cluster to work as an Outbound cluster

CreateMaintenanceDetails

Details for creation of maintenance details

CreateOpensearchClusterDetails

The configuration details for a new OpenSearch cluster.

CreateOpensearchClusterPipelineDetails

The configuration details for a new OpenSearch cluster pipeline.

CustomerLoggingDetails

Customer logging configuration

DeleteBlockVolumesForNamespaceDetails

delete block volumes for namespace

ExportOpensearchClusterBackupDetails

Information about the cluster backup to export.

ForcePatchClusterDetails

force patching a cluster.

ForcePatchPipelineDetails

force patching a pipeline.

GetManifestResponse

The response returned for the get manifest call.

MaintenanceDetails

Details for the maintenance activity.

MaintenanceNotificationDetails

Notification details for the maintenance activity.

MaintenanceNotificationFailure

Failed maintenance notification for a cluster

MaintenanceNotificationResponse

Response for request to send customer maintenance notification.

OpensearchCluster

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

OpensearchClusterBackup

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

OpensearchClusterBackupCollection

The list of cluster backups returned in a cluster backup search.

OpensearchClusterBackupSummary

The summary of information about an OpenSearch cluster backup.

OpensearchClusterCollection

The list of OpenSearch clusters returned in a cluster search.

OpensearchClusterInternalDetails

This is the ClusterLoadBalancer which can store the State of the cluster, opensearchLoadbalancerIps, remoteLoadbalancerIps

OpensearchClusterPipeline

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.

OpensearchClusterPipelineCollection

The list of cluster pipelines returned in a cluster pipeline search.

OpensearchClusterPipelineSummary

The summary of information about an OpenSearch cluster Pipeline.

OpensearchClusterSummary

The summary of information about an OpenSearch cluster.

OpensearchPipelineReverseConnectionEndpoint

The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.

OpensearchVersionsCollection

The list of OpenSearch versions returned in an OpenSearch version search.

OpensearchVersionsSummary

A description of Opensearch versions

OutboundClusterConfig

This configuration is used for passing request details to connect outbound cluster(s) to the inbound cluster (coordinating cluster)

OutboundClusterSummary

Contains details of a Outbound cluster

ReclaimClusterDetails

Reclaim Clusters from de-activated customer tenant accounts

ResizeOpensearchClusterHorizontalDetails

The node count configuration to update on an existing OpenSearch cluster for horizontal resizing.

ResizeOpensearchClusterVerticalDetails

The OCPU and memory configuration to update on an existing OpenSearch cluster for vertical resizing.

RestoreOpensearchClusterBackupDetails

Information about the source OpenSearch cluster to restore the cluster backup from.

RestoreOpensearchClusterDetails

Information about the OpenSearch cluster backup to restore.

ReverseConnectionEndpoint

Reverse connection endpoint has details of endpoint in customer VCN

SecuritySamlConfig

SAML policy is optionally used for Opensearch cluster to config SAML authentication

ShapesDetails

Shapes for OpenSearch Cluster.

UpdateCheckinDetails

Information about the update checkin event.

UpdateClusterHardenedImageDetails

Information about the cluster's hardened image.

UpdateClusterSpecsDetails

update cluster specs in Kiev.

UpdateClusterStatusDetails

Information about the update cluster event.

UpdateMaintenanceDetails

Details for update of maintenance details

UpdateOpensearchClusterBackupDetails

Information about the cluster backup to update.

UpdateOpensearchClusterDetails

The configuration to update on an existing OpenSearch cluster. Software version and security config are not allowed to be updated at the same time.

UpdateOpensearchClusterPipelineDetails

The configuration to update on an existing OpenSearch cluster pipeline. You can only edit capacity limits and pipeline configurations. You can't edit its network settings.

UpdatePipelineStatusDetails

update pipeline status.

UpgradeOpenSearchClusterDetails

Minor or major version upgrade of a cluster.

WorkRequest

An asynchronous work request.

WorkRequestCollection

Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.

WorkRequestError

An error encountered while executing an operation that is tracked by a work request.

WorkRequestErrorCollection

The list of work request errors returned in a work request error search.

WorkRequestLogEntry

A log message from executing an operation that is tracked by a work request.

WorkRequestLogEntryCollection

The list of work request log entries returned in a work request log search.

WorkRequestResource

A resource that is created or operated on by an asynchronous operation that is tracked by a work request.

Enums

ActionType

The way in which this resource was affected by the operation that spawned the work request.

BackupState

The result of a cluster backup operation.

BenchmarkDetails.PerfTestLengthEnum

CccMode

Mode for the cross cluster connection

DataNodeHostType

The instance type for the cluster's data nodes.

MaintenanceNotificationType

Maintenance Notification Type

MaintenanceState

State of the maintenance activity

MasterNodeHostType

The instance type for the cluster's master nodes.

OpensearchCluster.LifecycleStateEnum

OpensearchClusterBackup.BackupTypeEnum

OpensearchClusterBackup.LifecycleStateEnum

OpensearchClusterPipeline.LifecycleStateEnum

OpensearchClusterPipeline.PipelineModeEnum

OperationStatus

The status of the operation that spawned the work request.

OperationType

The types of operations that spawn work requests.

SearchNodeHostType

The instance type for the cluster's search nodes.

SecurityMode

The security mode of cluster

SortOrder

Sort orders.

UpgradeType

Upgrade Open Search cluster upgrade type(major or minor)

In this article
Back to top