Cloud AI Platform v1 API - Class ListEndpointsRequest (3.13.0) 

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

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

Request message for [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints].

Inheritance

object > ListEndpointsRequest

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

ListEndpointsRequest()

public ListEndpointsRequest()

ListEndpointsRequest(ListEndpointsRequest)

public ListEndpointsRequest(ListEndpointsRequest other)
Parameter
Name Description
other ListEndpointsRequest

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.

  • endpoint supports = and !=. endpoint represents the Endpoint ID, i.e. the last segment of the Endpoint's [resource name][google.cloud.aiplatform.v1.Endpoint.name].
  • display_name supports = and !=.
  • 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".
  • base_model_name only supports =.

Some examples:

  • endpoint=1
  • displayName="myDisplayName"
  • labels.myKey="myValue"
  • baseModelName="text-bison"
Property Value
Type Description
string

OrderBy

public string OrderBy { get; set; }

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:

  • display_name
  • create_time
  • update_time

Example: display_name, create_time desc.

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 [ListEndpointsResponse.next_page_token][google.cloud.aiplatform.v1.ListEndpointsResponse.next_page_token] of the previous [EndpointService.ListEndpoints][google.cloud.aiplatform.v1.EndpointService.ListEndpoints] call.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

Required. The resource name of the Location from which to list the Endpoints. 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