com.aliyun.sdk.service.polardb20170801.models

类 CreateDBClusterEndpointRequest.Builder

java.lang.Object

com.aliyun.sdk.service.polardb20170801.models.CreateDBClusterEndpointRequest.Builder

所有已实现的接口:

darabonba.core.RequestModel.Builder<CreateDBClusterEndpointRequest,CreateDBClusterEndpointRequest.Builder>

封闭类:

CreateDBClusterEndpointRequest

public static final class CreateDBClusterEndpointRequest.Builder
extends Object

方法概要

限定符和类型	方法和说明
CreateDBClusterEndpointRequest.Builder	autoAddNewNodes(String autoAddNewNodes) Specifies whether to automatically associate newly added nodes with the cluster endpoint.
CreateDBClusterEndpointRequest	build()
CreateDBClusterEndpointRequest.Builder	clientToken(String clientToken) The client token that is used to ensure the idempotence of the request.
CreateDBClusterEndpointRequest.Builder	DBClusterId(String DBClusterId) The ID of cluster.
CreateDBClusterEndpointRequest.Builder	DBEndpointDescription(String DBEndpointDescription) The name of the custom cluster endpoint.
CreateDBClusterEndpointRequest.Builder	endpointConfig(String endpointConfig) The advanced configurations of the cluster endpoint.
CreateDBClusterEndpointRequest.Builder	endpointType(String endpointType) The type of the cluster endpoint.
CreateDBClusterEndpointRequest.Builder	nodes(String nodes) The reader nodes that you want to associate with the endpoint.
CreateDBClusterEndpointRequest.Builder	ownerAccount(String ownerAccount) OwnerAccount.
CreateDBClusterEndpointRequest.Builder	ownerId(Long ownerId) OwnerId.
CreateDBClusterEndpointRequest.Builder	readWriteMode(String readWriteMode) The read/write mode.
CreateDBClusterEndpointRequest.Builder	resourceOwnerAccount(String resourceOwnerAccount) ResourceOwnerAccount.
CreateDBClusterEndpointRequest.Builder	resourceOwnerId(Long resourceOwnerId) ResourceOwnerId.

从类继承的方法 java.lang.Object

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

方法详细资料

autoAddNewNodes

public CreateDBClusterEndpointRequest.Builder autoAddNewNodes(String autoAddNewNodes)

Specifies whether to automatically associate newly added nodes with the cluster endpoint. Valid values:

* **Enable**: Newly added nodes are automatically associated with the cluster endpoint. * **Disable**: Newly added nodes are not automatically associated with the cluster endpoint. Default value: **Disable**.

clientToken

public CreateDBClusterEndpointRequest.Builder clientToken(String clientToken)

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. The token is case-sensitive.

DBClusterId

public CreateDBClusterEndpointRequest.Builder DBClusterId(String DBClusterId)

The ID of cluster.

DBEndpointDescription

public CreateDBClusterEndpointRequest.Builder DBEndpointDescription(String DBEndpointDescription)

The name of the custom cluster endpoint.

endpointConfig

public CreateDBClusterEndpointRequest.Builder endpointConfig(String endpointConfig)

The advanced configurations of the cluster endpoint. You must specify the configurations in the JSON format. You can specify the configurations of the following attributes: consistency level, transaction splitting, connection pool, and offload reads from the primary node.

* Specify the consistency level in the format of `{"ConsistLevel":"Consistency level"}`. Default value: 1. Valid values: * **0**: eventual consistency. * **1**: session consistency. * **2**: global consistency. * Specify the transaction splitting feature in the format of `{"DistributedTransaction":"Transaction splitting"}`. Valid values: * **on**: enables the transaction splitting feature. By default, the feature is enabled. * **off**: disables the transaction splitting feature. * Specify the offload reads from the primary node feature in the format of `{"MasterAcceptReads":"Offload reads from the primary node"}`. Default value: off. Valid values: * **on**: The primary node accepts read requests. * **off**: The primary node does not accept read requests. * Specify the connection pool in the format of `{"ConnectionPersist":"Connection pool"}`. Default value: off. Valid values: * **off**: disables the connection pool. * **Session**: enables the session-level connection pool. * **Transaction**: enables the transaction-level connection pool. >- You can specify the transaction splitting, connection pool, and offload reads from the primary node features for a PolarDB for MySQL cluster only if ReadWriteMode is set to ReadWrite for the cluster endpoint. >- Only PolarDB for MySQL supports global consistency. >- If the **ReadWriteMode** parameter is set to **ReadOnly**, the consistency level must be **0**. >- You can use one record to specify the consistency level, transaction splitting, connection pool, and offload reads from the primary node features, such as `{"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"}`. >- The transaction splitting settings are restricted by the consistency level settings. For example, if you set the consistency level to **0**, transaction splitting cannot be enabled. If you set the consistency level to **1** or **2**, transaction splitting can be enabled.

endpointType

public CreateDBClusterEndpointRequest.Builder endpointType(String endpointType)

The type of the cluster endpoint. Set the value to **Custom**.

nodes

public CreateDBClusterEndpointRequest.Builder nodes(String nodes)

The reader nodes that you want to associate with the endpoint. If you want to specify multiple reader nodes, separate the reader nodes with commas (,). If you do not specify this parameter, all nodes are used.

>- You need to specify the node IDs for a PolarDB for MySQL cluster. >- You need to specify the role name of each node for a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (Compatible with Oracle) cluster. Example: `Writer, Reader1, Reader2`. >- If you set **ReadWriteMode** to **ReadOnly**, you can associate only one node with the endpoint. If the only node becomes faulty, the cluster endpoint may be unavailable for up to 1 hour. We recommend that you associate more than one node with the cluster endpoint in production environments. We recommend that you associate at least two nodes with the cluster endpoint to improve service availability. >- If you set **ReadWriteMode** to **ReadWrite**, you need to associate at least two nodes with the cluster endpoint. >- PolarDB for MySQL does not impose a limit on the types of the two nodes. If the nodes are read-only nodes, write requests are forwarded to the primary node. >- PolarDB for PostgreSQL and PolarDB for PostgreSQL (compatible with Oracle) require a primary node.

ownerAccount

public CreateDBClusterEndpointRequest.Builder ownerAccount(String ownerAccount)

OwnerAccount.

ownerId

public CreateDBClusterEndpointRequest.Builder ownerId(Long ownerId)

OwnerId.

readWriteMode

public CreateDBClusterEndpointRequest.Builder readWriteMode(String readWriteMode)

The read/write mode. Valid values:

* **ReadWrite**: receives and forwards read and write requests. Automatic read/write splitting is enabled. * **ReadOnly**: The account has the read-only permissions on the database. Default value: **ReadOnly**.

resourceOwnerAccount

public CreateDBClusterEndpointRequest.Builder resourceOwnerAccount(String resourceOwnerAccount)

ResourceOwnerAccount.

resourceOwnerId

public CreateDBClusterEndpointRequest.Builder resourceOwnerId(Long resourceOwnerId)

ResourceOwnerId.

build

public CreateDBClusterEndpointRequest build()