Cloud AI Platform v1 API - Class ListIndexEndpointsRequest (3.2.0) 

public sealed class ListIndexEndpointsRequest : IMessage<ListIndexEndpointsRequest>, IEquatable<ListIndexEndpointsRequest>, IDeepCloneable<ListIndexEndpointsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Cloud AI Platform v1 API class ListIndexEndpointsRequest.

Request message for [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints].

Inheritance

object > ListIndexEndpointsRequest

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

ListIndexEndpointsRequest()

public ListIndexEndpointsRequest()

ListIndexEndpointsRequest(ListIndexEndpointsRequest)

public ListIndexEndpointsRequest(ListIndexEndpointsRequest other)
Parameter
Name Description
other ListIndexEndpointsRequest

Properties

Filter

public string Filter { get; set; }

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][google.cloud.aiplatform.v1.IndexEndpoint.name].
  • 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"
Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

Optional. The standard list page size.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

Optional. The standard list page token. Typically obtained via [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token] of the previous [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints] call.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

Required. The resource name of the Location from which to list the IndexEndpoints. Format: projects/{project}/locations/{location}

Property Value
Type Description
string

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type Description
LocationName

ReadMask

public FieldMask ReadMask { get; set; }

Optional. Mask specifying which fields to read.

Property Value
Type Description
FieldMask