@alicloud/elasticsearch20170613 4.3.0 → 4.3.2

package/src/models/CreateLogstashRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateLogstashRequestNetworkConfig extends $dara.Model {
   /**
+   * @remarks
+   * The network type. Currently, only VPC is supported.
+   * 
    * @example
    * vpc
    */
   type?: string;
   /**
    * @remarks
+   * The VPC ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -18,6 +23,8 @@ export class CreateLogstashRequestNetworkConfig extends $dara.Model {
   vpcId?: string;
   /**
    * @remarks
+   * The zone where the instance is deployed.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -26,6 +33,8 @@ export class CreateLogstashRequestNetworkConfig extends $dara.Model {
   vsArea?: string;
   /**
    * @remarks
+   * The vSwitch ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -61,21 +70,32 @@ export class CreateLogstashRequestNetworkConfig extends $dara.Model {
 
 export class CreateLogstashRequestNodeSpec extends $dara.Model {
   /**
+   * @remarks
+   * The disk size of the node. Unit: GB.
+   * 
    * @example
    * 50
    */
   disk?: number;
   /**
+   * @remarks
+   * The disk type of the node. Valid values:
+   * 
+   * - cloud_ssd
+   * - cloud_efficiency.
+   * 
    * @example
    * cloud_ssd
    */
   diskType?: string;
   /**
    * @remarks
+   * The node specifications. For more information about specifications, see [Product specifications](https://help.aliyun.com/document_detail/271718.html).
+   * 
    * This parameter is required.
    * 
    * @example
-   * logstash.n4.small
+   * elasticsearch.ic5.2xlarge
    */
   spec?: string;
   static names(): { [key: string]: string } {
@@ -105,21 +125,39 @@ export class CreateLogstashRequestNodeSpec extends $dara.Model {
 
 export class CreateLogstashRequestPaymentInfo extends $dara.Model {
   /**
+   * @remarks
+   * The auto-renewal epoch. Unit: months. This parameter is required when **isAutoRenew** is set to **true**. The valid values are the same as those on the buy page.
+   * 
    * @example
    * 3
    */
   autoRenewDuration?: number;
   /**
+   * @remarks
+   * The subscription duration. You can purchase the instance on a monthly or yearly basis. Unit: 1 to 9 months, or 1 to 3 years.
+   * 
    * @example
    * 1
    */
   duration?: number;
   /**
+   * @remarks
+   * Specifies whether to enable auto-renewal. Valid values:
+   * 
+   * - true: Enabled.
+   * - false: Disabled.
+   * 
    * @example
    * false
    */
   isAutoRenew?: boolean;
   /**
+   * @remarks
+   * The unit of the subscription duration. Valid values:
+   * 
+   * - Year: year.
+   * - Month: month.
+   * 
    * @example
    * Month
    */
@@ -153,17 +191,24 @@ export class CreateLogstashRequestPaymentInfo extends $dara.Model {
 
 export class CreateLogstashRequest extends $dara.Model {
   /**
+   * @remarks
+   * The name of the instance.
+   * 
    * @example
    * ls-cn-abc
    */
   description?: string;
   /**
    * @remarks
+   * The network configuration.
+   * 
    * This parameter is required.
    */
   networkConfig?: CreateLogstashRequestNetworkConfig;
   /**
    * @remarks
+   * The number of nodes in the instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -172,18 +217,42 @@ export class CreateLogstashRequest extends $dara.Model {
   nodeAmount?: number;
   /**
    * @remarks
+   * The configuration of data nodes.
+   * 
    * This parameter is required.
    */
   nodeSpec?: CreateLogstashRequestNodeSpec;
+  /**
+   * @remarks
+   * The billing details of the subscription instance. This parameter is required when you create a subscription instance.
+   */
   paymentInfo?: CreateLogstashRequestPaymentInfo;
   /**
+   * @remarks
+   * The billing method of the instance. Valid values:
+   * 
+   * - prepaid: subscription.
+   * - postpaid: pay-as-you-go.
+   * 
    * @example
    * prepaid
    */
   paymentType?: string;
+  /**
+   * @remarks
+   * The ID of the resource group to which the instance belongs.
+   * 
+   * @example
+   * rg-acfmxxkk2p7****
+   */
   resourceGroupId?: string;
   /**
    * @remarks
+   * The instance version. Valid values:
+   * 
+   * - 6.7_with_X-Pack
+   * - 7.4_with_X-Pack.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -191,6 +260,9 @@ export class CreateLogstashRequest extends $dara.Model {
    */
   version?: string;
   /**
+   * @remarks
+   * A unique token that is used to ensure the idempotence of the request. The client generates this value. The value must be unique among different requests and cannot exceed 64 ASCII characters in length.
+   * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
    */

package/src/models/CreateLogstashResponseBody.ts

@@ -5,10 +5,17 @@ import { Logstash } from "./Logstash";
 
 export class CreateLogstashResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE*****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The returned result.
+   */
   result?: Logstash;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreatePipelinesRequest.ts

@@ -4,17 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreatePipelinesRequestBody extends $dara.Model {
   /**
+   * @remarks
+   * The batch delay of the pipeline. Unit: milliseconds. Default value: 50.
+   * 
    * @example
    * 50
    */
   batchDelay?: number;
   /**
+   * @remarks
+   * The batch size of the pipeline. Default value: 125.
+   * 
    * @example
    * 125
    */
   batchSize?: number;
   /**
    * @remarks
+   * The pipeline configuration.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -22,12 +30,17 @@ export class CreatePipelinesRequestBody extends $dara.Model {
    */
   config?: string;
   /**
+   * @remarks
+   * The pipeline description.
+   * 
    * @example
    * this is a test
    */
   description?: string;
   /**
    * @remarks
+   * The pipeline ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -35,21 +48,35 @@ export class CreatePipelinesRequestBody extends $dara.Model {
    */
   pipelineId?: string;
   /**
+   * @remarks
+   * The number of checkpoint writes for the queue. Default value: 1024.
+   * 
    * @example
    * 1024
    */
   queueCheckPointWrites?: number;
   /**
+   * @remarks
+   * The total capacity of the queue in bytes. Unit: MB. Default value: 1024.
+   * 
    * @example
    * 1024
    */
   queueMaxBytes?: number;
   /**
+   * @remarks
+   * The queue type. Valid values:
+   * - MEMORY: a traditional memory-based queue.
+   * - PERSISTED: a disk-based ACKed queue (persistent queue).
+   * 
    * @example
    * MEMORY
    */
   queueType?: string;
   /**
+   * @remarks
+   * The number of worker threads for the pipeline. Default value: the number of CPU cores of the instance.
+   * 
    * @example
    * 2
    */
@@ -93,12 +120,25 @@ export class CreatePipelinesRequestBody extends $dara.Model {
 
 export class CreatePipelinesRequest extends $dara.Model {
   /**
+   * @remarks
+   * A unique token generated by the client to ensure the idempotence of the request. The token can contain up to 64 ASCII characters and must be unique across requests.
+   * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
    */
   clientToken?: string;
+  /**
+   * @remarks
+   * The request body parameters that specify the pipeline information. For more information, see [logstash.yml](https://www.elastic.co/guide/en/logstash/6.7/logstash-settings-file.html).
+   */
   body?: CreatePipelinesRequestBody[];
   /**
+   * @remarks
+   * Specifies whether to save and deploy the pipeline. Valid values:
+   * 
+   * - true: Save and deploy.
+   * - false (default): Save only.
+   * 
    * @example
    * false
    */

package/src/models/CreatePipelinesResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreatePipelinesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the pipeline is created. Valid values:
+   * 
+   * - true: The pipeline is created.
+   * - false: The pipeline failed to be created.
+   * 
    * @example
    * true
    */

package/src/models/CreateSnapshotRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateSnapshotRequest extends $dara.Model {
   /**
    * @remarks
-   * A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.
+   * A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
    * 
    * This parameter is required.
    * 

package/src/models/CreateSnapshotResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateSnapshotResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***
@@ -13,10 +13,10 @@ export class CreateSnapshotResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Return results:
+   * The returned result. Valid values:
    * 
-   * *   true: manual snapshot backup successfully
-   * *   false: manual snapshot backup failed
+   * - true: The manual snapshot backup is successful.
+   * - false: The manual snapshot backup failed.
    * 
    * @example
    * true

package/src/models/CreateVpcEndpointRequest.ts

@@ -5,25 +5,34 @@ import * as $dara from '@darabonba/typescript';
 export class CreateVpcEndpointRequest extends $dara.Model {
   /**
    * @remarks
-   * The returned result details.
+   * A client token that is used to ensure the idempotence of the request. The value is generated by the client and must be unique among different requests. The value can contain up to 64 ASCII characters.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***
    */
   clientToken?: string;
   /**
+   * @remarks
+   * The ID of the endpoint service that you created. The service VPC endpoint will be associated with this service ID.
+   * 
    * @example
    * epsrv-hp3xdsq46ael67lo****
    */
   serviceId?: string;
   /**
+   * @remarks
+   * The zone ID of the endpoint service that you created.
+   * 
    * @example
    * cn-hangzhou-i
    */
   zoneId?: string;
   /**
    * @remarks
-   * The ID of the user endpoint service associated with the endpoint.
+   * Specifies whether to perform a dry run. Valid values:
+   * 
+   * - true: sends a check request without creating an endpoint. The system checks whether the AccessKey pair is valid, whether the Resource Access Management (RAM) user has the required authorization, and whether the required parameters are specified.
+   * - false (default): triggers the request to create an endpoint.
    * 
    * @example
    * false

package/src/models/CreateVpcEndpointResponseBody.ts

@@ -4,23 +4,32 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateVpcEndpointResponseBodyResult extends $dara.Model {
   /**
+   * @remarks
+   * The endpoint domain name, which is used for connection configuration.
+   * 
    * @example
    * ep-bp1tah7zbrwmkjef****.epsrv-bp1w0p3jdirbfmt6****.cn-hangzhou.privatelink.aliyuncs.com
    */
   endpointDomain?: string;
   /**
+   * @remarks
+   * The ID of the service VPC endpoint.
+   * 
    * @example
    * ep-bp1tah7zbrwmkjef****
    */
   endpointId?: string;
   /**
+   * @remarks
+   * The name of the service VPC endpoint.
+   * 
    * @example
    * vpcElasticSearchABC
    */
   endpointName?: string;
   /**
    * @remarks
-   * The name of the service VPC-side endpoint.
+   * The ID of the user endpoint service associated with the endpoint.
    * 
    * @example
    * epsrv-bp1w0p3jdirbfmt6****
@@ -56,7 +65,7 @@ export class CreateVpcEndpointResponseBodyResult extends $dara.Model {
 export class CreateVpcEndpointResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The endpoint domain name, which is used to configure the connection.
+   * The request ID.
    * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC47D9
@@ -64,7 +73,7 @@ export class CreateVpcEndpointResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The ID of the endpoint on the service VPC side.
+   * The returned result.
    */
   result?: CreateVpcEndpointResponseBodyResult;
   static names(): { [key: string]: string } {

package/src/models/DeactivateZonesRequest.ts

@@ -6,7 +6,7 @@ export class DeactivateZonesRequest extends $dara.Model {
   body?: string;
   /**
    * @remarks
-   * Used to ensure idempotency of the request. The client generates this parameter value and must guarantee its uniqueness across different requests, with a maximum length of 64 ASCII characters.
+   * A unique token used to ensure idempotence. This value is generated by the client and must be unique across different requests. The value can be up to 64 ASCII characters in length.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****

package/src/models/DeactivateZonesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeactivateZonesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC****
@@ -13,10 +13,10 @@ export class DeactivateZonesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Return result:
+   * The returned result. Valid values:
    * 
-   * - true: Zone offline successful
-   * - false: Zone offline failed
+   * - true: The zones are taken offline.
+   * - false: The zones failed to be taken offline.
    * 
    * @example
    * true

package/src/models/DeleteCollectorRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteCollectorRequest extends $dara.Model {
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
+   * A unique token used to ensure idempotence. Generated by the client. The value must be unique across different requests and cannot exceed 64 ASCII characters in length.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****

package/src/models/DeleteCollectorResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteCollectorResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
@@ -13,10 +13,9 @@ export class DeleteCollectorResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the shipper is deleted. Valid values:
-   * 
-   * *   true: The shipper is deleted.
-   * *   false: The shipper fails to be deleted.
+   * The returned result. Valid values:
+   * - true: The deletion was successful.
+   * - false: The deletion failed.
    * 
    * @example
    * true

package/src/models/DeleteComponentIndexResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteComponentIndexResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC47D9
    */
   requestId?: string;
   /**
+   * @remarks
+   * The returned result. Valid values:
+   * 
+   * - true: The deletion was successful.
+   * - false: The deletion failed.
+   * 
    * @example
    * true
    */

package/src/models/DeleteConnectedClusterRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteConnectedClusterRequest extends $dara.Model {
   /**
    * @remarks
-   * A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.
+   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
    * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
@@ -13,7 +13,7 @@ export class DeleteConnectedClusterRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The ID of the remote instance for which the network connection is established.
+   * The instance ID of the remote instance that is connected over the network.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteConnectedClusterResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteConnectedClusterResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***
@@ -13,10 +13,10 @@ export class DeleteConnectedClusterResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Return results:
+   * The result of the operation. Valid values:
    * 
-   * *   true: remove the interworking instance successfully
-   * *   false: remove the interworking instance failed
+   * - true: The connected instance is removed.
+   * - false: The connected instance failed to be removed.
    * 
    * @example
    * true

package/src/models/DeleteDataStreamRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteDataStreamRequest extends $dara.Model {
   /**
+   * @remarks
+   * A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
+   * 
    * @example
    * 5A2CFF0E-5718-45B5-9D4D-70B3FF****
    */

package/src/models/DeleteDataStreamResponseBody.ts

@@ -4,11 +4,21 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteDataStreamResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The result of the operation. Valid values:
+   * 
+   * - true: The data stream was deleted.
+   * 
+   * - false: The data stream failed to be deleted.
+   * 
    * @example
    * true
    */

package/src/models/DeleteDataTaskRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteDataTaskRequest extends $dara.Model {
   /**
    * @remarks
-   * A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.
+   * A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class DeleteDataTaskRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The ID of the index migration task.
+   * The index migration task ID.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteDataTaskResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteDataTaskResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***
@@ -13,7 +13,7 @@ export class DeleteDataTaskResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The returned results.
+   * The returned result.
    * 
    * @example
    * true

package/src/models/DeleteDeprecatedTemplateResponseBody.ts

@@ -4,11 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteDeprecatedTemplateResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * F99407AB-2FA9-489E-A259-40CF6DCC47D9
    */
   requestId?: string;
   /**
+   * @remarks
+   * The result. Valid values:
+   * 
+   * - true: succeeded.
+   * - false: failed.
+   * 
    * @example
    * true
    */