@alicloud/appstream-center20210901 3.2.2 → 4.0.0

package/src/models/ListAppInstanceGroupResponseBodyAppInstanceGroupModels.ts

@@ -0,0 +1,410 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { ListAppInstanceGroupResponseBodyAppInstanceGroupModelsApps } from "./ListAppInstanceGroupResponseBodyAppInstanceGroupModelsApps";
+import { ListAppInstanceGroupResponseBodyAppInstanceGroupModelsNodePool } from "./ListAppInstanceGroupResponseBodyAppInstanceGroupModelsNodePool";
+import { ListAppInstanceGroupResponseBodyAppInstanceGroupModelsOtaInfo } from "./ListAppInstanceGroupResponseBodyAppInstanceGroupModelsOtaInfo";
+import { ListAppInstanceGroupResponseBodyAppInstanceGroupModelsResourceTags } from "./ListAppInstanceGroupResponseBodyAppInstanceGroupModelsResourceTags";
+import { ListAppInstanceGroupResponseBodyAppInstanceGroupModelsTags } from "./ListAppInstanceGroupResponseBodyAppInstanceGroupModelsTags";
+
+
+export class ListAppInstanceGroupResponseBodyAppInstanceGroupModels extends $dara.Model {
+  /**
+   * @example
+   * INTERNET
+   */
+  accessType?: string;
+  /**
+   * @remarks
+   * The number of subscription resources. Minimum value: 1.
+   * 
+   * @example
+   * 1
+   */
+  amount?: number;
+  /**
+   * @remarks
+   * The image ID of the app.
+   * 
+   * @example
+   * img-8z4nztpaqvay4****
+   */
+  appCenterImageId?: string;
+  /**
+   * @remarks
+   * The ID of the delivery group.
+   * 
+   * @example
+   * aig-9ciijz60n4xsv****
+   */
+  appInstanceGroupId?: string;
+  /**
+   * @remarks
+   * The name of the delivery group.
+   */
+  appInstanceGroupName?: string;
+  /**
+   * @remarks
+   * The resource type of the delivery group.
+   * 
+   * @example
+   * __dynamic__
+   */
+  appInstanceType?: string;
+  /**
+   * @remarks
+   * The policy ID.
+   * 
+   * @example
+   * pg-g3k5wa2ms2****
+   */
+  appPolicyId?: string;
+  /**
+   * @example
+   * false
+   */
+  appPolicyImageCheck?: boolean;
+  /**
+   * @example
+   * CENTER
+   */
+  appPolicyVersion?: string;
+  /**
+   * @remarks
+   * The apps.
+   */
+  apps?: ListAppInstanceGroupResponseBodyAppInstanceGroupModelsApps[];
+  /**
+   * @example
+   * App
+   */
+  authMode?: string;
+  /**
+   * @remarks
+   * The sales mode.
+   * 
+   * Valid values:
+   * 
+   * *   AppInstance: by session
+   * *   Node: by resource
+   * 
+   * @example
+   * Node
+   */
+  chargeResourceMode?: string;
+  /**
+   * @remarks
+   * The billing method.
+   * 
+   * Valid values:
+   * 
+   * *   PostPaid: pay-as-you-go
+   * *   PrePaid: subscription
+   * 
+   * @example
+   * PrePaid
+   */
+  chargeType?: string;
+  /**
+   * @remarks
+   * The time when the delivery group expires.
+   * 
+   * @example
+   * 2022-04-27T16:00:00.000+00:00
+   */
+  expiredTime?: string;
+  /**
+   * @remarks
+   * The time when the delivery group was created.
+   * 
+   * @example
+   * 2022-04-26T15:06:16.000+00:00
+   */
+  gmtCreate?: string;
+  /**
+   * @remarks
+   * The maximum number of instances. Minimum value: 1.
+   * 
+   * @example
+   * 10
+   */
+  maxAmount?: number;
+  /**
+   * @remarks
+   * The minimum number of instances. Minimum value: 1.
+   * 
+   * @example
+   * 1
+   */
+  minAmount?: number;
+  /**
+   * @remarks
+   * The resource groups.
+   */
+  nodePool?: ListAppInstanceGroupResponseBodyAppInstanceGroupModelsNodePool[];
+  /**
+   * @example
+   * cn-beijing+dir-172301****
+   */
+  officeSiteId?: string;
+  /**
+   * @remarks
+   * The type of the operating system.
+   * 
+   * Valid value:
+   * 
+   * *   Windows
+   * 
+   * @example
+   * Windows
+   */
+  osType?: string;
+  /**
+   * @remarks
+   * The information about the over-the-air (OTA) update task.
+   */
+  otaInfo?: ListAppInstanceGroupResponseBodyAppInstanceGroupModelsOtaInfo;
+  /**
+   * @remarks
+   * The product type.
+   * 
+   * Valid value:
+   * 
+   * *   CloudApp: App Streaming
+   * 
+   * @example
+   * CloudApp
+   */
+  productType?: string;
+  /**
+   * @remarks
+   * The ID of the region where the delivery group resides. For information about the supported regions, see [Limits](https://help.aliyun.com/document_detail/426036.html).
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The percentage of reserved instances. The value indicates the percentage of unused sessions in the delivery group. Valid values: 0 to 99.
+   * 
+   * @example
+   * 20
+   */
+  reserveAmountRatio?: string;
+  /**
+   * @remarks
+   * The maximum number of reserved instances. The value indicates the maximum number of unused sessions in the delivery group. Minimum value: 1.
+   * 
+   * @example
+   * 5
+   */
+  reserveMaxAmount?: number;
+  /**
+   * @remarks
+   * The minimum number of reserved instances. The value indicates the minimum number of unused sessions in the delivery group. Minimum value: 1.
+   * 
+   * @example
+   * 1
+   */
+  reserveMinAmount?: number;
+  /**
+   * @remarks
+   * The resource status.
+   * 
+   * Valid values:
+   * 
+   * *   AVAILABLE
+   * *   RELEASED
+   * *   EXPIRED_IN_7_DAYS
+   * *   UNAVAILABLE
+   * *   UPGRADING
+   * *   CREATING
+   * 
+   * @example
+   * AVAILABLE
+   */
+  resourceStatus?: string;
+  /**
+   * @remarks
+   * The resource tags.
+   */
+  resourceTags?: ListAppInstanceGroupResponseBodyAppInstanceGroupModelsResourceTags[];
+  /**
+   * @remarks
+   * The duration for which no session is connected. Unit: minutes. If no session is connected in the resources after the specified duration elapses, auto scale-in is triggered. Minimum value: 0.
+   * 
+   * @example
+   * 5
+   */
+  scalingDownAfterIdleMinutes?: number;
+  /**
+   * @remarks
+   * The number of sessions that are created each time the delivery group is scaled out. Minimum value: 1.
+   * 
+   * @example
+   * 10
+   */
+  scalingStep?: number;
+  /**
+   * @remarks
+   * The upper limit of session usage. If the session usage exceeds the specified upper limit, auto scale-out is triggered. The session usage rate is calculated by using the following formula: Session usage rate = Number of sessions in use/Total number of sessions × 100%. Valid values: 0 to 99.
+   * 
+   * @example
+   * 85
+   */
+  scalingUsageThreshold?: string;
+  /**
+   * @remarks
+   * The duration for which sessions are retained after disconnection. Unit: minutes. After an end user disconnects from a session, the session is closed only after the specified duration elapses. If you want to permanently retain sessions, set this parameter to `-1`. Valid values:-1 and 3 to 300. Default value: `15`.
+   * 
+   * @example
+   * 15
+   */
+  sessionTimeout?: string;
+  /**
+   * @remarks
+   * Indicates whether user permission verification is skipped.
+   * 
+   * Valid values:
+   * 
+   * *   true
+   * *   false: This is the default value.
+   * 
+   * @example
+   * false
+   */
+  skipUserAuthCheck?: boolean;
+  /**
+   * @remarks
+   * The specification ID that uniquely corresponds to the ID of the delivery group.
+   * 
+   * @example
+   * spec-8o18t8uc31qib0****
+   */
+  specId?: string;
+  /**
+   * @remarks
+   * The status of the delivery group.
+   * 
+   * Valid values:
+   * 
+   * *   PUBLISHED: The delivery group is published.
+   * *   FAILED: The delivery group failed to be published.
+   * *   MAINTAIN_FAILED: The delivery group failed to be updated.
+   * *   EXPIRED: The delivery group is expired.
+   * *   MAINTAINING: The delivery group is being updated.
+   * *   CEASED: The delivery group has overdue payments.
+   * *   EXPIRED_RECYCLING: The delivery group is expired and being recycled.
+   * *   DEPLOYING: The delivery group is being published.
+   * 
+   * @example
+   * PUBLISHED
+   */
+  status?: string;
+  tags?: ListAppInstanceGroupResponseBodyAppInstanceGroupModelsTags[];
+  static names(): { [key: string]: string } {
+    return {
+      accessType: 'AccessType',
+      amount: 'Amount',
+      appCenterImageId: 'AppCenterImageId',
+      appInstanceGroupId: 'AppInstanceGroupId',
+      appInstanceGroupName: 'AppInstanceGroupName',
+      appInstanceType: 'AppInstanceType',
+      appPolicyId: 'AppPolicyId',
+      appPolicyImageCheck: 'AppPolicyImageCheck',
+      appPolicyVersion: 'AppPolicyVersion',
+      apps: 'Apps',
+      authMode: 'AuthMode',
+      chargeResourceMode: 'ChargeResourceMode',
+      chargeType: 'ChargeType',
+      expiredTime: 'ExpiredTime',
+      gmtCreate: 'GmtCreate',
+      maxAmount: 'MaxAmount',
+      minAmount: 'MinAmount',
+      nodePool: 'NodePool',
+      officeSiteId: 'OfficeSiteId',
+      osType: 'OsType',
+      otaInfo: 'OtaInfo',
+      productType: 'ProductType',
+      regionId: 'RegionId',
+      reserveAmountRatio: 'ReserveAmountRatio',
+      reserveMaxAmount: 'ReserveMaxAmount',
+      reserveMinAmount: 'ReserveMinAmount',
+      resourceStatus: 'ResourceStatus',
+      resourceTags: 'ResourceTags',
+      scalingDownAfterIdleMinutes: 'ScalingDownAfterIdleMinutes',
+      scalingStep: 'ScalingStep',
+      scalingUsageThreshold: 'ScalingUsageThreshold',
+      sessionTimeout: 'SessionTimeout',
+      skipUserAuthCheck: 'SkipUserAuthCheck',
+      specId: 'SpecId',
+      status: 'Status',
+      tags: 'Tags',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      accessType: 'string',
+      amount: 'number',
+      appCenterImageId: 'string',
+      appInstanceGroupId: 'string',
+      appInstanceGroupName: 'string',
+      appInstanceType: 'string',
+      appPolicyId: 'string',
+      appPolicyImageCheck: 'boolean',
+      appPolicyVersion: 'string',
+      apps: { 'type': 'array', 'itemType': ListAppInstanceGroupResponseBodyAppInstanceGroupModelsApps },
+      authMode: 'string',
+      chargeResourceMode: 'string',
+      chargeType: 'string',
+      expiredTime: 'string',
+      gmtCreate: 'string',
+      maxAmount: 'number',
+      minAmount: 'number',
+      nodePool: { 'type': 'array', 'itemType': ListAppInstanceGroupResponseBodyAppInstanceGroupModelsNodePool },
+      officeSiteId: 'string',
+      osType: 'string',
+      otaInfo: ListAppInstanceGroupResponseBodyAppInstanceGroupModelsOtaInfo,
+      productType: 'string',
+      regionId: 'string',
+      reserveAmountRatio: 'string',
+      reserveMaxAmount: 'number',
+      reserveMinAmount: 'number',
+      resourceStatus: 'string',
+      resourceTags: { 'type': 'array', 'itemType': ListAppInstanceGroupResponseBodyAppInstanceGroupModelsResourceTags },
+      scalingDownAfterIdleMinutes: 'number',
+      scalingStep: 'number',
+      scalingUsageThreshold: 'string',
+      sessionTimeout: 'string',
+      skipUserAuthCheck: 'boolean',
+      specId: 'string',
+      status: 'string',
+      tags: { 'type': 'array', 'itemType': ListAppInstanceGroupResponseBodyAppInstanceGroupModelsTags },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.apps)) {
+      $dara.Model.validateArray(this.apps);
+    }
+    if(Array.isArray(this.nodePool)) {
+      $dara.Model.validateArray(this.nodePool);
+    }
+    if(this.otaInfo && typeof (this.otaInfo as any).validate === 'function') {
+      (this.otaInfo as any).validate();
+    }
+    if(Array.isArray(this.resourceTags)) {
+      $dara.Model.validateArray(this.resourceTags);
+    }
+    if(Array.isArray(this.tags)) {
+      $dara.Model.validateArray(this.tags);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ListAppInstanceGroupResponseBodyAppInstanceGroupModelsApps.ts

@@ -0,0 +1,68 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ListAppInstanceGroupResponseBodyAppInstanceGroupModelsApps extends $dara.Model {
+  /**
+   * @remarks
+   * The app icon.
+   * 
+   * @example
+   * https://app-center-icon-****.png
+   */
+  appIcon?: string;
+  /**
+   * @remarks
+   * The app ID.
+   * 
+   * @example
+   * ca-i87mycyn419nu****
+   */
+  appId?: string;
+  /**
+   * @remarks
+   * The app name.
+   */
+  appName?: string;
+  /**
+   * @remarks
+   * The app version.
+   * 
+   * @example
+   * 1.0.0
+   */
+  appVersion?: string;
+  /**
+   * @remarks
+   * The name of the app version.
+   */
+  appVersionName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      appIcon: 'AppIcon',
+      appId: 'AppId',
+      appName: 'AppName',
+      appVersion: 'AppVersion',
+      appVersionName: 'AppVersionName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      appIcon: 'string',
+      appId: 'string',
+      appName: 'string',
+      appVersion: 'string',
+      appVersionName: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ListAppInstanceGroupResponseBodyAppInstanceGroupModelsNodePool.ts

@@ -0,0 +1,226 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { ListAppInstanceGroupResponseBodyAppInstanceGroupModelsNodePoolRecurrenceSchedules } from "./ListAppInstanceGroupResponseBodyAppInstanceGroupModelsNodePoolRecurrenceSchedules";
+
+
+export class ListAppInstanceGroupResponseBodyAppInstanceGroupModelsNodePool extends $dara.Model {
+  /**
+   * @remarks
+   * The number of resources purchased when the delivery group was created.
+   * 
+   * @example
+   * 2
+   */
+  amount?: number;
+  /**
+   * @remarks
+   * The maximum number of idle sessions. After you specify a value for this parameter, auto scale-out is triggered only if the number of idle sessions in the delivery group is smaller than the specified value and the session usage exceeds the value specified for `ScalingUsageThreshold`. Otherwise, the system determines that idle sessions in the delivery group are sufficient and does not perform auto scale-out.`` You can use this parameter to flexibly manage auto scaling and reduce costs.
+   * 
+   * @example
+   * 3
+   */
+  maxIdleAppInstanceAmount?: number;
+  /**
+   * @remarks
+   * The maximum number of resources that can be created for scale-out.
+   * 
+   * @example
+   * 8
+   */
+  maxScalingAmount?: number;
+  /**
+   * @remarks
+   * The total number of subscription resources.
+   * 
+   * @example
+   * 1
+   */
+  nodeAmount?: number;
+  /**
+   * @remarks
+   * The maximum number of sessions that can be connected to a resource at the same time. If a resource connects to a large number of sessions at the same time, user experience can be compromised. The value range varies based on the resource specification. The following items describe the value ranges of different resource types:
+   * 
+   * *   appstreaming.general.4c8g: 1 to 2
+   * *   appstreaming.general.8c16g: 1 to 4
+   * *   appstreaming.vgpu.8c16g.4g: 1 to 4
+   * *   appstreaming.vgpu.8c31g.16g: 1 to 4
+   * *   appstreaming.vgpu.14c93g.12g: 1 to 6
+   * 
+   * @example
+   * 2
+   */
+  nodeCapacity?: number;
+  /**
+   * @remarks
+   * The ID of the resource specification that you purchase.
+   * 
+   * @example
+   * appstreaming.vgpu.4c8g.2g
+   */
+  nodeInstanceType?: string;
+  /**
+   * @remarks
+   * The ID of the resource group.
+   * 
+   * @example
+   * rg-g6922kced36hx****
+   */
+  nodePoolId?: string;
+  /**
+   * @remarks
+   * The name of the resource specification.
+   */
+  nodeTypeName?: string;
+  /**
+   * @remarks
+   * The number of subscription resources that are in use.
+   * 
+   * @example
+   * 1
+   */
+  nodeUsed?: number;
+  /**
+   * @remarks
+   * The intervals at which the scaling policy is executed.
+   */
+  recurrenceSchedules?: ListAppInstanceGroupResponseBodyAppInstanceGroupModelsNodePoolRecurrenceSchedules[];
+  /**
+   * @remarks
+   * The duration for which no session is connected. Unit: minutes. If no session is connected in the resources after the specified duration elapses, auto scale-in is triggered. Default value: 5.
+   * 
+   * @example
+   * 5
+   */
+  scalingDownAfterIdleMinutes?: number;
+  /**
+   * @remarks
+   * The total number of scalable resources.
+   * 
+   * @example
+   * 8
+   */
+  scalingNodeAmount?: number;
+  /**
+   * @remarks
+   * The number of scalable resources that are in use.
+   * 
+   * @example
+   * 4
+   */
+  scalingNodeUsed?: number;
+  /**
+   * @remarks
+   * The number of resources that are created each time resources are scaled out. Valid values: 1 to 10.
+   * 
+   * @example
+   * 2
+   */
+  scalingStep?: number;
+  /**
+   * @remarks
+   * The upper limit of session usage. If the session usage exceeds the specified upper limit, auto scale-out is triggered. The session usage is calculated by using the following formula: `Session usage = Number of current sessions/(Total number of resources × Number of concurrent sessions) × 100%`.
+   * 
+   * @example
+   * 85
+   */
+  scalingUsageThreshold?: string;
+  /**
+   * @remarks
+   * The expiration date of the scaling policy. Format: yyyy-MM-dd.
+   * 
+   * @example
+   * 2022-09-08
+   */
+  strategyDisableDate?: string;
+  /**
+   * @remarks
+   * The effective date of the scaling policy. Format: yyyy-MM-dd.
+   * 
+   * @example
+   * 2022-08-01
+   */
+  strategyEnableDate?: string;
+  /**
+   * @remarks
+   * The type of the scaling policy.
+   * 
+   * >  `NODE_SCALING_BY_USAGE` is returned for this parameter only if ChargeType is set to `PrePaid`. `NODE_SCALING_BY_SCHEDULE` is returned for this parameter only if ChargeType is set to `PostPaid`.
+   * 
+   * Valid values:
+   * 
+   * *   NODE_FIXED: No scalable resources are used.
+   * *   NODE_SCALING_BY_SCHEDULE: Scheduled scaling is used.
+   * *   NODE_SCALING_BY_USAGE: Resources are scaled based on usage.
+   * 
+   * @example
+   * NODE_FIXED
+   */
+  strategyType?: string;
+  /**
+   * @remarks
+   * Indicates whether resource prefetch is enabled.
+   * 
+   * @example
+   * false
+   */
+  warmUp?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      amount: 'Amount',
+      maxIdleAppInstanceAmount: 'MaxIdleAppInstanceAmount',
+      maxScalingAmount: 'MaxScalingAmount',
+      nodeAmount: 'NodeAmount',
+      nodeCapacity: 'NodeCapacity',
+      nodeInstanceType: 'NodeInstanceType',
+      nodePoolId: 'NodePoolId',
+      nodeTypeName: 'NodeTypeName',
+      nodeUsed: 'NodeUsed',
+      recurrenceSchedules: 'RecurrenceSchedules',
+      scalingDownAfterIdleMinutes: 'ScalingDownAfterIdleMinutes',
+      scalingNodeAmount: 'ScalingNodeAmount',
+      scalingNodeUsed: 'ScalingNodeUsed',
+      scalingStep: 'ScalingStep',
+      scalingUsageThreshold: 'ScalingUsageThreshold',
+      strategyDisableDate: 'StrategyDisableDate',
+      strategyEnableDate: 'StrategyEnableDate',
+      strategyType: 'StrategyType',
+      warmUp: 'WarmUp',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      amount: 'number',
+      maxIdleAppInstanceAmount: 'number',
+      maxScalingAmount: 'number',
+      nodeAmount: 'number',
+      nodeCapacity: 'number',
+      nodeInstanceType: 'string',
+      nodePoolId: 'string',
+      nodeTypeName: 'string',
+      nodeUsed: 'number',
+      recurrenceSchedules: { 'type': 'array', 'itemType': ListAppInstanceGroupResponseBodyAppInstanceGroupModelsNodePoolRecurrenceSchedules },
+      scalingDownAfterIdleMinutes: 'number',
+      scalingNodeAmount: 'number',
+      scalingNodeUsed: 'number',
+      scalingStep: 'number',
+      scalingUsageThreshold: 'string',
+      strategyDisableDate: 'string',
+      strategyEnableDate: 'string',
+      strategyType: 'string',
+      warmUp: 'boolean',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.recurrenceSchedules)) {
+      $dara.Model.validateArray(this.recurrenceSchedules);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+