Vertex AI v1 API - Class ListEntityTypesRequest (3.67.0) 

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

Reference documentation and code samples for the Vertex AI v1 API class ListEntityTypesRequest.

Request message for [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes].

Inheritance

object > ListEntityTypesRequest

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

ListEntityTypesRequest()

public ListEntityTypesRequest()

ListEntityTypesRequest(ListEntityTypesRequest)

public ListEntityTypesRequest(ListEntityTypesRequest other)
Parameter
Name Description
other ListEntityTypesRequest

Properties

Filter

public string Filter { get; set; }

Lists the EntityTypes that match the filter expression. The following filters are supported:

  • create_time: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format.
  • update_time: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format.
  • labels: Supports key-value equality as well as key presence.

Examples:

  • create_time > \"2020-01-31T15:30:00.000000Z\" OR update_time > \"2020-01-31T15:30:00.000000Z\" --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z.
  • labels.active = yes AND labels.env = prod --> EntityTypes having both (active: yes) and (env: prod) labels.
  • labels.env: * --> Any EntityType which has a label with 'env' as the key.
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:

  • entity_type_id
  • create_time
  • update_time
Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

A page token, received from a previous [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes] must match the call that provided the page token.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

Required. The resource name of the Featurestore to list EntityTypes. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

Property Value
Type Description
string

ParentAsFeaturestoreName

public FeaturestoreName ParentAsFeaturestoreName { get; set; }

FeaturestoreName-typed view over the Parent resource name property.

Property Value
Type Description
FeaturestoreName

ReadMask

public FieldMask ReadMask { get; set; }

Mask specifying which fields to read.

Property Value
Type Description
FieldMask