@nutanix-scratch/volumes-js-client 4.0.1 → 4.2.1

package/dist/es/apis/volumegroups-endpoints.d.ts

@@ -1,6 +1,6 @@
 /**
  * VolumeGroups service.
- * @version 4.0.1
+ * @version 4.2.1
  * @class VolumeGroupsApi
  */
 export class VolumeGroupsApi {
@@ -36,6 +36,15 @@ export class VolumeGroupsApi {
      * @return {Promise<AttachIscsiClientApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link AttachIscsiClientApiResponse } and HTTP response
      */
     attachIscsiClient(extId: string, body: Partial<IscsiClient>, ...args: any): Promise<AttachIscsiClientApiResponse>;
+    /**
+     * Attach an NVMe-TCP client to the given Volume Group
+     * Attaches a NVMe-TCP client/initiator to a Volume Group identified by its external identifier.
+     * @param { Partial<NvmfClient> } body specification
+     * @param { String } extId The external identifier of a Volume Group.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<AttachNvmfClientApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link AttachNvmfClientApiResponse } and HTTP response
+     */
+    attachNvmfClient(extId: string, body: Partial<NvmfClient>, ...args: any): Promise<AttachNvmfClientApiResponse>;
     /**
      * Attach an AHV VM to the given Volume Group
      * Attaches VM to a Volume Group identified by {extId}.
@@ -88,6 +97,15 @@ export class VolumeGroupsApi {
      * @return {Promise<DetachIscsiClientApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DetachIscsiClientApiResponse } and HTTP response
      */
     detachIscsiClient(extId: string, body: Partial<IscsiClientAttachment>, ...args: any): Promise<DetachIscsiClientApiResponse>;
+    /**
+     * Detach a NVMe-TCP client from the given Volume Group
+     * Detaches a NVMe-TCP client/initiator from a Volume Group identified by its external identifier.
+     * @param { Partial<NvmfClient> } body specification
+     * @param { String } extId The external identifier of a Volume Group.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<DetachNvmfClientApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DetachNvmfClientApiResponse } and HTTP response
+     */
+    detachNvmfClient(extId: string, body: Partial<NvmfClient>, ...args: any): Promise<DetachNvmfClientApiResponse>;
     /**
      * Detach an AHV VM from the given Volume Group
      * Detaches VM identified by {extId} from a Volume Group identified by {volumeGroupExtId}.
@@ -129,17 +147,6 @@ export class VolumeGroupsApi {
 
      * @param { DownSamplingOperator } opts.$statType
      * @param { String } opts.$select A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned.
-- controllerAvgIOLatencyUsecs
-- controllerAvgReadIOLatencyUsecs
-- controllerAvgWriteIOLatencyUsecs
-- controllerIOBandwidthKBps
-- controllerNumIOPS
-- controllerNumReadIOPS
-- controllerNumWriteIOPS
-- controllerReadIOBandwidthKBps
-- controllerUserBytes
-- controllerWriteIOBandwidthKBps
-
      * @param {Object} args Additional Arguments
      * @return {Promise<GetVolumeDiskStatsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetVolumeDiskStatsApiResponse } and HTTP response
      */
@@ -152,10 +159,14 @@ export class VolumeGroupsApi {
      * Get a Volume Group
      * Query the Volume Group identified by {extId}.
      * @param { String } extId The external identifier of a Volume Group.
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { String } opts.$expand A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. Each expanded item is evaluated relative to the entity containing the property being expanded. Other query options can be applied to an expanded property by appending a semicolon-separated list of query options, enclosed in parentheses, to the property name. Permissible system query options are $filter, $select and $orderby.
      * @param {Object} args Additional Arguments
      * @return {Promise<GetVolumeGroupApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetVolumeGroupApiResponse } and HTTP response
      */
-    getVolumeGroupById(extId: string, ...args: any): Promise<GetVolumeGroupApiResponse>;
+    getVolumeGroupById(extId: string, opts: {
+        $expand: string;
+    }, ...args: any): Promise<GetVolumeGroupApiResponse>;
     /**
      * Fetch metadata information associated with a Volume Group.
      * Query for metadata information which is associated with the Volume Group identified by {extId}.
@@ -178,17 +189,6 @@ export class VolumeGroupsApi {
 
      * @param { DownSamplingOperator } opts.$statType
      * @param { String } opts.$select A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned.
-- controllerAvgIOLatencyUsecs
-- controllerAvgReadIOLatencyUsecs
-- controllerAvgWriteIOLatencyUsecs
-- controllerIOBandwidthKBps
-- controllerNumIOPS
-- controllerNumReadIOPS
-- controllerNumWriteIOPS
-- controllerReadIOBandwidthKBps
-- controllerUserBytes
-- controllerWriteIOBandwidthKBps
-
      * @param {Object} args Additional Arguments
      * @return {Promise<GetVolumeGroupStatsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetVolumeGroupStatsApiResponse } and HTTP response
      */
@@ -225,22 +225,10 @@ export class VolumeGroupsApi {
      * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
 
      * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
-     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.<br>
-     * The filter can be applied to the following fields:<br>
-     * - clusterReference<br>
-     * - extId
-     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.<br>
-     * The orderby can be applied to the following fields:<br>
-     * - clusterReference<br>
-     * - createdTime<br>
-     * - extId
-     * @param { String } opts.$expand A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. Each expanded item is evaluated relative to the entity containing the property being expanded. Other query options can be applied to an expanded property by appending a semicolon-separated list of query options, enclosed in parentheses, to the property name. Permissible system query options are $filter, $select and $orderby. The following expansion keys are supported.
-- iscsiClient
-
+     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.
+     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.
+     * @param { String } opts.$expand A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. Each expanded item is evaluated relative to the entity containing the property being expanded. Other query options can be applied to an expanded property by appending a semicolon-separated list of query options, enclosed in parentheses, to the property name. Permissible system query options are $filter, $select and $orderby.
      * @param { String } opts.$select A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned.
-- clusterReference
-- extId
-
      * @param {Object} args Additional Arguments
      * @return {Promise<ListExternalIscsiAttachmentsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListExternalIscsiAttachmentsApiResponse } and HTTP response
      */
@@ -263,13 +251,8 @@ export class VolumeGroupsApi {
      * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
 
      * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
-     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.<br>
-     * The filter can be applied to the following fields:<br>
-     * - extId
-     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.<br>
-     * The orderby can be applied to the following fields:<br>
-     * - createdTime<br>
-     * - extId
+     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.
+     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.
      * @param {Object} args Additional Arguments
      * @return {Promise<ListVmAttachmentsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListVmAttachmentsApiResponse } and HTTP response
      */
@@ -289,17 +272,9 @@ export class VolumeGroupsApi {
      * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
 
      * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
-     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.<br>
-     * The filter can be applied to the following fields:<br>
-     * - storageContainerId
-     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.<br>
-     * The orderby can be applied to the following fields:<br>
-     * - createdTime<br>
-     * - diskSizeBytes
+     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.
+     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.
      * @param { String } opts.$select A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned.
-- extId
-- storageContainerId
-
      * @param {Object} args Additional Arguments
      * @return {Promise<ListVolumeDisksApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListVolumeDisksApiResponse } and HTTP response
      */
@@ -319,26 +294,10 @@ export class VolumeGroupsApi {
      * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
 
      * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
-     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.<br>
-     * The filter can be applied to the following fields:<br>
-     * - clusterReference<br>
-     * - extId<br>
-     * - name
-     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.<br>
-     * The orderby can be applied to the following fields:<br>
-     * - clusterReference<br>
-     * - createdTime<br>
-     * - extId<br>
-     * - name
-     * @param { String } opts.$expand A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. Each expanded item is evaluated relative to the entity containing the property being expanded. Other query options can be applied to an expanded property by appending a semicolon-separated list of query options, enclosed in parentheses, to the property name. Permissible system query options are $filter, $select and $orderby. The following expansion keys are supported.
-- cluster
-- metadata
-
+     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.
+     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.
+     * @param { String } opts.$expand A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. Each expanded item is evaluated relative to the entity containing the property being expanded. Other query options can be applied to an expanded property by appending a semicolon-separated list of query options, enclosed in parentheses, to the property name. Permissible system query options are $filter, $select and $orderby.
      * @param { String } opts.$select A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned.
-- clusterReference
-- extId
-- name
-
      * @param {Object} args Additional Arguments
      * @return {Promise<ListVolumeGroupsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListVolumeGroupsApiResponse } and HTTP response
      */
@@ -384,6 +343,8 @@ import CategoryEntityReferences from "../models/volumes/v4/config/CategoryEntity
 import AssociateCategoryApiResponse from "../models/volumes/v4/config/AssociateCategoryApiResponse";
 import IscsiClient from "../models/volumes/v4/config/IscsiClient";
 import AttachIscsiClientApiResponse from "../models/volumes/v4/config/AttachIscsiClientApiResponse";
+import NvmfClient from "../models/volumes/v4/config/NvmfClient";
+import AttachNvmfClientApiResponse from "../models/volumes/v4/config/AttachNvmfClientApiResponse";
 import VmAttachment from "../models/volumes/v4/config/VmAttachment";
 import AttachVmApiResponse from "../models/volumes/v4/config/AttachVmApiResponse";
 import VolumeDisk from "../models/volumes/v4/config/VolumeDisk";
@@ -394,6 +355,7 @@ import DeleteVolumeDiskApiResponse from "../models/volumes/v4/config/DeleteVolum
 import DeleteVolumeGroupApiResponse from "../models/volumes/v4/config/DeleteVolumeGroupApiResponse";
 import IscsiClientAttachment from "../models/volumes/v4/config/IscsiClientAttachment";
 import DetachIscsiClientApiResponse from "../models/volumes/v4/config/DetachIscsiClientApiResponse";
+import DetachNvmfClientApiResponse from "../models/volumes/v4/config/DetachNvmfClientApiResponse";
 import DetachVmApiResponse from "../models/volumes/v4/config/DetachVmApiResponse";
 import DisassociateCategoryApiResponse from "../models/volumes/v4/config/DisassociateCategoryApiResponse";
 import GetVolumeDiskApiResponse from "../models/volumes/v4/config/GetVolumeDiskApiResponse";