com.google.cloud.aiplatform.v1beta1

Interface ListEntityTypesRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListEntityTypesRequest, ListEntityTypesRequest.Builder

public interface ListEntityTypesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFilter() Lists the EntityTypes that match the filter expression.
com.google.protobuf.ByteString	getFilterBytes() Lists the EntityTypes that match the filter expression.
String	getOrderBy() A comma-separated list of fields to order by, sorted in ascending order.
com.google.protobuf.ByteString	getOrderByBytes() A comma-separated list of fields to order by, sorted in ascending order.
int	getPageSize() The maximum number of EntityTypes to return.
String	getPageToken() A page token, received from a previous [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes] call.
com.google.protobuf.ByteString	getPageTokenBytes() A page token, received from a previous [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListEntityTypes] call.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
com.google.protobuf.FieldMask	getReadMask() Mask specifying which fields to read.
com.google.protobuf.FieldMaskOrBuilder	getReadMaskOrBuilder() Mask specifying which fields to read.
boolean	hasReadMask() Mask specifying which fields to read.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for parent.

getFilter

String getFilter()

 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.
 

string filter = 2;

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 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.
 

string filter = 2;

Returns:

The bytes for filter.

getPageSize

int getPageSize()

 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.
 

int32 page_size = 3;

Returns:

The pageSize.

getPageToken

String getPageToken()

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

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

string page_token = 4;

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

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

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

string page_token = 4;

Returns:

The bytes for pageToken.

getOrderBy

String getOrderBy()

 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`
 

string order_by = 5;

Returns:

The orderBy.

getOrderByBytes

com.google.protobuf.ByteString getOrderByBytes()

 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`
 

string order_by = 5;

Returns:

The bytes for orderBy.

hasReadMask

boolean hasReadMask()

 Mask specifying which fields to read.
 

.google.protobuf.FieldMask read_mask = 6;

Returns:

Whether the readMask field is set.

getReadMask

com.google.protobuf.FieldMask getReadMask()

 Mask specifying which fields to read.
 

.google.protobuf.FieldMask read_mask = 6;

Returns:

The readMask.

getReadMaskOrBuilder

com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()

 Mask specifying which fields to read.
 

.google.protobuf.FieldMask read_mask = 6;