list method

Future<ListSingleTenantHsmInstanceProposalsResponse> list(String parent, { String? filter, String? orderBy, int? pageSize, String? pageToken, bool? showDeleted, String? $fields, })

Lists SingleTenantHsmInstanceProposals.

Request parameters:

parent - Required. The resource name of the single tenant HSM instance associated with the SingleTenantHsmInstanceProposals to list, in the format projects / * /locations / * /singleTenantHsmInstances / * . Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/singleTenantHsmInstances/\[^/\]+$.

filter - Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results.

orderBy - Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results.

pageSize - Optional. Optional limit on the number of SingleTenantHsmInstanceProposals to include in the response. Further SingleTenantHsmInstanceProposals can subsequently be obtained by including the ListSingleTenantHsmInstanceProposalsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

pageToken - Optional. Optional pagination token, returned earlier via ListSingleTenantHsmInstanceProposalsResponse.next_page_token.

showDeleted - Optional. If set to true, HsmManagement.ListSingleTenantHsmInstanceProposals will also return SingleTenantHsmInstanceProposals in DELETED state.

$fields - Selector specifying which fields to include in a partial response.

Completes with a ListSingleTenantHsmInstanceProposalsResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<ListSingleTenantHsmInstanceProposalsResponse> list(
  core.String parent, {
  core.String? filter,
  core.String? orderBy,
  core.int? pageSize,
  core.String? pageToken,
  core.bool? showDeleted,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'filter': ?filter == null ? null : [filter],
    'orderBy': ?orderBy == null ? null : [orderBy],
    'pageSize': ?pageSize == null ? null : ['${pageSize}'],
    'pageToken': ?pageToken == null ? null : [pageToken],
    'showDeleted': ?showDeleted == null ? null : ['${showDeleted}'],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/proposals';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return ListSingleTenantHsmInstanceProposalsResponse.fromJson(
    response_ as core.Map<core.String, core.dynamic>,
  );
}