Package com.oracle.bmc.opensearch.model

Class CreateOpensearchClusterDetails.Builder

java.lang.Object

com.oracle.bmc.opensearch.model.CreateOpensearchClusterDetails.Builder

Enclosing class:

CreateOpensearchClusterDetails

public static class CreateOpensearchClusterDetails.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CreateOpensearchClusterDetails.Builder	backupPolicy(BackupPolicy backupPolicy)
CreateOpensearchClusterDetails	build()
CreateOpensearchClusterDetails.Builder	certificateConfig(CertificateConfig certificateConfig)
CreateOpensearchClusterDetails.Builder	compartmentId(String compartmentId)	The OCID of the compartment to create the cluster in.
CreateOpensearchClusterDetails.Builder	copy(CreateOpensearchClusterDetails model)
CreateOpensearchClusterDetails.Builder	dataNodeCount(Integer dataNodeCount)	The number of data nodes to configure for the cluster.
CreateOpensearchClusterDetails.Builder	dataNodeHostBareMetalShape(String dataNodeHostBareMetalShape)	The bare metal shape for the cluster’s data nodes.
CreateOpensearchClusterDetails.Builder	dataNodeHostMemoryGB(Integer dataNodeHostMemoryGB)	The amount of memory in GB, to configure per node for the cluster’s data nodes.
CreateOpensearchClusterDetails.Builder	dataNodeHostOcpuCount(Integer dataNodeHostOcpuCount)	The number of OCPUs to configure for the cluster’s data nodes.
CreateOpensearchClusterDetails.Builder	dataNodeHostShape(String dataNodeHostShape)	The node shape for the cluster’s data nodes.
CreateOpensearchClusterDetails.Builder	dataNodeHostType(DataNodeHostType dataNodeHostType)	TThe instance type for the cluster’s data nodes.
CreateOpensearchClusterDetails.Builder	dataNodeStorageGB(Integer dataNodeStorageGB)	The amount of storage in GB, to configure per node for the cluster’s data nodes.
CreateOpensearchClusterDetails.Builder	definedTags(Map<String,Map<String,Object>> definedTags)	Defined tags for this resource.
CreateOpensearchClusterDetails.Builder	displayName(String displayName)	The name of the cluster.
CreateOpensearchClusterDetails.Builder	freeformTags(Map<String,String> freeformTags)	Simple key-value pair that is applied without any predefined name, type or scope.
CreateOpensearchClusterDetails.Builder	inboundClusterIds(List<String> inboundClusterIds)	List of inbound clusters that will be queried using cross cluster search
CreateOpensearchClusterDetails.Builder	maintenanceDetails(CreateMaintenanceDetails maintenanceDetails)
CreateOpensearchClusterDetails.Builder	masterNodeCount(Integer masterNodeCount)	The number of master nodes to configure for the cluster.
CreateOpensearchClusterDetails.Builder	masterNodeHostBareMetalShape(String masterNodeHostBareMetalShape)	The bare metal shape for the cluster’s master nodes.
CreateOpensearchClusterDetails.Builder	masterNodeHostMemoryGB(Integer masterNodeHostMemoryGB)	The amount of memory in GB, to configure per node for the cluster’s master nodes.
CreateOpensearchClusterDetails.Builder	masterNodeHostOcpuCount(Integer masterNodeHostOcpuCount)	The number of OCPUs to configure for the cluser’s master nodes.
CreateOpensearchClusterDetails.Builder	masterNodeHostShape(String masterNodeHostShape)	The node shape for the cluster’s master nodes.
CreateOpensearchClusterDetails.Builder	masterNodeHostType(MasterNodeHostType masterNodeHostType)	The instance type for the cluster’s master nodes.
CreateOpensearchClusterDetails.Builder	nsgId(String nsgId)	The OCID of the NSG where the private endpoint vnic will be attached.
CreateOpensearchClusterDetails.Builder	opendashboardNodeCount(Integer opendashboardNodeCount)	The number of OpenSearch Dashboard nodes to configure for the cluster.
CreateOpensearchClusterDetails.Builder	opendashboardNodeHostMemoryGB(Integer opendashboardNodeHostMemoryGB)	The amount of memory in GB, to configure for the cluster’s OpenSearch Dashboard nodes.
CreateOpensearchClusterDetails.Builder	opendashboardNodeHostOcpuCount(Integer opendashboardNodeHostOcpuCount)	The number of OCPUs to configure for the cluster’s OpenSearch Dashboard nodes.
CreateOpensearchClusterDetails.Builder	opendashboardNodeHostShape(String opendashboardNodeHostShape)	The node shape for the cluster’s OpenSearch Dashboard nodes.
CreateOpensearchClusterDetails.Builder	outboundClusterConfig(OutboundClusterConfig outboundClusterConfig)
CreateOpensearchClusterDetails.Builder	reverseConnectionEndpointCustomerIps(List<String> reverseConnectionEndpointCustomerIps)	The customer IP addresses of the endpoint in customer VCN
CreateOpensearchClusterDetails.Builder	searchNodeCount(Integer searchNodeCount)	The number of search nodes configured for the cluster.
CreateOpensearchClusterDetails.Builder	searchNodeHostMemoryGB(Integer searchNodeHostMemoryGB)	The amount of memory in GB, for the cluster’s search nodes.
CreateOpensearchClusterDetails.Builder	searchNodeHostOcpuCount(Integer searchNodeHostOcpuCount)	The number of OCPUs configured for the cluster’s search nodes.
CreateOpensearchClusterDetails.Builder	searchNodeHostShape(String searchNodeHostShape)	The node shape for the cluster’s search nodes.
CreateOpensearchClusterDetails.Builder	searchNodeHostType(SearchNodeHostType searchNodeHostType)	The instance type for the cluster’s search nodes.
CreateOpensearchClusterDetails.Builder	searchNodeStorageGB(Integer searchNodeStorageGB)	The amount of storage in GB, to configure per node for the cluster’s search nodes.
CreateOpensearchClusterDetails.Builder	securityAttributes(Map<String,Map<String,Object>> securityAttributes)	Security attributes for this resource.
CreateOpensearchClusterDetails.Builder	securityMasterUserName(String securityMasterUserName)	The name of the master user that are used to manage security config
CreateOpensearchClusterDetails.Builder	securityMasterUserPasswordHash(String securityMasterUserPasswordHash)	The password hash of the master user that are used to manage security config
CreateOpensearchClusterDetails.Builder	securityMode(SecurityMode securityMode)	The security mode of the cluster.
CreateOpensearchClusterDetails.Builder	securitySamlConfig(SecuritySamlConfig securitySamlConfig)
CreateOpensearchClusterDetails.Builder	softwareVersion(String softwareVersion)	The version of the software the cluster is running.
CreateOpensearchClusterDetails.Builder	subnetCompartmentId(String subnetCompartmentId)	The OCID for the compartment where the cluster’s subnet is located.
CreateOpensearchClusterDetails.Builder	subnetId(String subnetId)	The OCID of the cluster’s subnet.
CreateOpensearchClusterDetails.Builder	systemTags(Map<String,Map<String,Object>> systemTags)	Usage of system tag keys.
CreateOpensearchClusterDetails.Builder	vcnCompartmentId(String vcnCompartmentId)	The OCID for the compartment where the cluster’s VCN is located.
CreateOpensearchClusterDetails.Builder	vcnId(String vcnId)	The OCID of the cluster’s VCN.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

displayName

public CreateOpensearchClusterDetails.Builder displayName(String displayName)

The name of the cluster.

Avoid entering confidential information.

Parameters:

displayName - the value to set

Returns:

this builder

compartmentId

public CreateOpensearchClusterDetails.Builder compartmentId(String compartmentId)

The OCID of the compartment to create the cluster in.

Parameters:

compartmentId - the value to set

Returns:

this builder

softwareVersion

public CreateOpensearchClusterDetails.Builder softwareVersion(String softwareVersion)

The version of the software the cluster is running.

Parameters:

softwareVersion - the value to set

Returns:

this builder

masterNodeCount

public CreateOpensearchClusterDetails.Builder masterNodeCount(Integer masterNodeCount)

The number of master nodes to configure for the cluster.

Parameters:

masterNodeCount - the value to set

Returns:

this builder

masterNodeHostType

public CreateOpensearchClusterDetails.Builder masterNodeHostType(MasterNodeHostType masterNodeHostType)

The instance type for the cluster’s master nodes.

Parameters:

masterNodeHostType - the value to set

Returns:

this builder

masterNodeHostBareMetalShape

public CreateOpensearchClusterDetails.Builder masterNodeHostBareMetalShape(String masterNodeHostBareMetalShape)

The bare metal shape for the cluster’s master nodes.

Parameters:

masterNodeHostBareMetalShape - the value to set

Returns:

this builder

masterNodeHostShape

public CreateOpensearchClusterDetails.Builder masterNodeHostShape(String masterNodeHostShape)

The node shape for the cluster’s master nodes.

Parameters:

masterNodeHostShape - the value to set

Returns:

this builder

masterNodeHostOcpuCount

public CreateOpensearchClusterDetails.Builder masterNodeHostOcpuCount(Integer masterNodeHostOcpuCount)

The number of OCPUs to configure for the cluser’s master nodes.

Parameters:

masterNodeHostOcpuCount - the value to set

Returns:

this builder

masterNodeHostMemoryGB

public CreateOpensearchClusterDetails.Builder masterNodeHostMemoryGB(Integer masterNodeHostMemoryGB)

The amount of memory in GB, to configure per node for the cluster’s master nodes.

Parameters:

masterNodeHostMemoryGB - the value to set

Returns:

this builder

dataNodeCount

public CreateOpensearchClusterDetails.Builder dataNodeCount(Integer dataNodeCount)

The number of data nodes to configure for the cluster.

Parameters:

dataNodeCount - the value to set

Returns:

this builder

dataNodeHostType

public CreateOpensearchClusterDetails.Builder dataNodeHostType(DataNodeHostType dataNodeHostType)

TThe instance type for the cluster’s data nodes.

Parameters:

dataNodeHostType - the value to set

Returns:

this builder

dataNodeHostBareMetalShape

public CreateOpensearchClusterDetails.Builder dataNodeHostBareMetalShape(String dataNodeHostBareMetalShape)

The bare metal shape for the cluster’s data nodes.

Parameters:

dataNodeHostBareMetalShape - the value to set

Returns:

this builder

dataNodeHostShape

public CreateOpensearchClusterDetails.Builder dataNodeHostShape(String dataNodeHostShape)

The node shape for the cluster’s data nodes.

Parameters:

dataNodeHostShape - the value to set

Returns:

this builder

dataNodeHostOcpuCount

public CreateOpensearchClusterDetails.Builder dataNodeHostOcpuCount(Integer dataNodeHostOcpuCount)

The number of OCPUs to configure for the cluster’s data nodes.

Parameters:

dataNodeHostOcpuCount - the value to set

Returns:

this builder

dataNodeHostMemoryGB

public CreateOpensearchClusterDetails.Builder dataNodeHostMemoryGB(Integer dataNodeHostMemoryGB)

The amount of memory in GB, to configure per node for the cluster’s data nodes.

Parameters:

dataNodeHostMemoryGB - the value to set

Returns:

this builder

dataNodeStorageGB

public CreateOpensearchClusterDetails.Builder dataNodeStorageGB(Integer dataNodeStorageGB)

The amount of storage in GB, to configure per node for the cluster’s data nodes.

Parameters:

dataNodeStorageGB - the value to set

Returns:

this builder

opendashboardNodeHostShape

public CreateOpensearchClusterDetails.Builder opendashboardNodeHostShape(String opendashboardNodeHostShape)

The node shape for the cluster’s OpenSearch Dashboard nodes.

Parameters:

opendashboardNodeHostShape - the value to set

Returns:

this builder

opendashboardNodeCount

public CreateOpensearchClusterDetails.Builder opendashboardNodeCount(Integer opendashboardNodeCount)

The number of OpenSearch Dashboard nodes to configure for the cluster.

Parameters:

opendashboardNodeCount - the value to set

Returns:

this builder

opendashboardNodeHostOcpuCount

public CreateOpensearchClusterDetails.Builder opendashboardNodeHostOcpuCount(Integer opendashboardNodeHostOcpuCount)

The number of OCPUs to configure for the cluster’s OpenSearch Dashboard nodes.

Parameters:

opendashboardNodeHostOcpuCount - the value to set

Returns:

this builder

opendashboardNodeHostMemoryGB

public CreateOpensearchClusterDetails.Builder opendashboardNodeHostMemoryGB(Integer opendashboardNodeHostMemoryGB)

The amount of memory in GB, to configure for the cluster’s OpenSearch Dashboard nodes.

Parameters:

opendashboardNodeHostMemoryGB - the value to set

Returns:

this builder

searchNodeCount

public CreateOpensearchClusterDetails.Builder searchNodeCount(Integer searchNodeCount)

The number of search nodes configured for the cluster.

Parameters:

searchNodeCount - the value to set

Returns:

this builder

searchNodeHostType

public CreateOpensearchClusterDetails.Builder searchNodeHostType(SearchNodeHostType searchNodeHostType)

The instance type for the cluster’s search nodes.

Parameters:

searchNodeHostType - the value to set

Returns:

this builder

searchNodeHostShape

public CreateOpensearchClusterDetails.Builder searchNodeHostShape(String searchNodeHostShape)

The node shape for the cluster’s search nodes.

Parameters:

searchNodeHostShape - the value to set

Returns:

this builder

searchNodeHostOcpuCount

public CreateOpensearchClusterDetails.Builder searchNodeHostOcpuCount(Integer searchNodeHostOcpuCount)

The number of OCPUs configured for the cluster’s search nodes.

Parameters:

searchNodeHostOcpuCount - the value to set

Returns:

this builder

searchNodeHostMemoryGB

public CreateOpensearchClusterDetails.Builder searchNodeHostMemoryGB(Integer searchNodeHostMemoryGB)

The amount of memory in GB, for the cluster’s search nodes.

Parameters:

searchNodeHostMemoryGB - the value to set

Returns:

this builder

searchNodeStorageGB

public CreateOpensearchClusterDetails.Builder searchNodeStorageGB(Integer searchNodeStorageGB)

The amount of storage in GB, to configure per node for the cluster’s search nodes.

Parameters:

searchNodeStorageGB - the value to set

Returns:

this builder

vcnId

public CreateOpensearchClusterDetails.Builder vcnId(String vcnId)

The OCID of the cluster’s VCN.

Parameters:

vcnId - the value to set

Returns:

this builder

subnetId

public CreateOpensearchClusterDetails.Builder subnetId(String subnetId)

The OCID of the cluster’s subnet.

Parameters:

subnetId - the value to set

Returns:

this builder

vcnCompartmentId

public CreateOpensearchClusterDetails.Builder vcnCompartmentId(String vcnCompartmentId)

The OCID for the compartment where the cluster’s VCN is located.

Parameters:

vcnCompartmentId - the value to set

Returns:

this builder

subnetCompartmentId

public CreateOpensearchClusterDetails.Builder subnetCompartmentId(String subnetCompartmentId)

The OCID for the compartment where the cluster’s subnet is located.

Parameters:

subnetCompartmentId - the value to set

Returns:

this builder

securityMode

public CreateOpensearchClusterDetails.Builder securityMode(SecurityMode securityMode)

The security mode of the cluster.

Parameters:

securityMode - the value to set

Returns:

this builder

securityMasterUserName

public CreateOpensearchClusterDetails.Builder securityMasterUserName(String securityMasterUserName)

The name of the master user that are used to manage security config

Parameters:

securityMasterUserName - the value to set

Returns:

this builder

securityMasterUserPasswordHash

public CreateOpensearchClusterDetails.Builder securityMasterUserPasswordHash(String securityMasterUserPasswordHash)

The password hash of the master user that are used to manage security config

Parameters:

securityMasterUserPasswordHash - the value to set

Returns:

this builder

securitySamlConfig

public CreateOpensearchClusterDetails.Builder securitySamlConfig(SecuritySamlConfig securitySamlConfig)

backupPolicy

public CreateOpensearchClusterDetails.Builder backupPolicy(BackupPolicy backupPolicy)

nsgId

public CreateOpensearchClusterDetails.Builder nsgId(String nsgId)

The OCID of the NSG where the private endpoint vnic will be attached.

Parameters:

nsgId - the value to set

Returns:

this builder

reverseConnectionEndpointCustomerIps

public CreateOpensearchClusterDetails.Builder reverseConnectionEndpointCustomerIps(List<String> reverseConnectionEndpointCustomerIps)

The customer IP addresses of the endpoint in customer VCN

Parameters:

reverseConnectionEndpointCustomerIps - the value to set

Returns:

this builder

inboundClusterIds

public CreateOpensearchClusterDetails.Builder inboundClusterIds(List<String> inboundClusterIds)

List of inbound clusters that will be queried using cross cluster search

Parameters:

inboundClusterIds - the value to set

Returns:

this builder

outboundClusterConfig

public CreateOpensearchClusterDetails.Builder outboundClusterConfig(OutboundClusterConfig outboundClusterConfig)

maintenanceDetails

public CreateOpensearchClusterDetails.Builder maintenanceDetails(CreateMaintenanceDetails maintenanceDetails)

certificateConfig

public CreateOpensearchClusterDetails.Builder certificateConfig(CertificateConfig certificateConfig)

freeformTags

public CreateOpensearchClusterDetails.Builder freeformTags(Map<String,String> freeformTags)

Simple key-value pair that is applied without any predefined name, type or scope.

Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Parameters:

freeformTags - the value to set

Returns:

this builder

definedTags

public CreateOpensearchClusterDetails.Builder definedTags(Map<String,Map<String,Object>> definedTags)

Defined tags for this resource.

Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Parameters:

definedTags - the value to set

Returns:

this builder

systemTags

public CreateOpensearchClusterDetails.Builder systemTags(Map<String,Map<String,Object>> systemTags)

Usage of system tag keys.

These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Parameters:

systemTags - the value to set

Returns:

this builder

securityAttributes

public CreateOpensearchClusterDetails.Builder securityAttributes(Map<String,Map<String,Object>> securityAttributes)

Security attributes for this resource.

Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}

Parameters:

securityAttributes - the value to set

Returns:

this builder

build

public CreateOpensearchClusterDetails build()

copy

public CreateOpensearchClusterDetails.Builder copy(CreateOpensearchClusterDetails model)