list method

Future<GoogleCloudAiplatformV1ListIndexEndpointsResponse> list(
  1. String parent, {
  2. String? filter,
  3. int? pageSize,
  4. String? pageToken,
  5. String? readMask,
  6. String? $fields,
})

Lists IndexEndpoints in a Location.

Request parameters:

parent - Required. The resource name of the Location from which to list the IndexEndpoints. Format: projects/{project}/locations/{location} Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+$.

filter - Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * index_endpoint supports = and !=. index_endpoint represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * display_name supports =, != and regex() (uses re2 syntax) * labels supports general map functions that is: labels.key=value - key:value equality labels.key:* or labels:key - key existence A key including a space must be quoted. labels."a key". Some examples: * index_endpoint="1"*display_name="myDisplayName"*regex(display_name, "^A") -> The display name starts with an A. * labels.myKey="myValue"

pageSize - Optional. The standard list page size.

pageToken - Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.

readMask - Optional. Mask specifying which fields to read.

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

Completes with a GoogleCloudAiplatformV1ListIndexEndpointsResponse.

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<GoogleCloudAiplatformV1ListIndexEndpointsResponse> list(
  core.String parent, {
  core.String? filter,
  core.int? pageSize,
  core.String? pageToken,
  core.String? readMask,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (readMask != null) 'readMask': [readMask],
    if ($fields != null) 'fields': [$fields],
  };

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

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