Class ListEntityTypesRequest.Builder (3.44.0)

public static final class ListEntityTypesRequest.Builder extends GeneratedMessageV3.Builder<ListEntityTypesRequest.Builder> implements ListEntityTypesRequestOrBuilder

Request message for FeaturestoreService.ListEntityTypes.

Protobuf type google.cloud.aiplatform.v1.ListEntityTypesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListEntityTypesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListEntityTypesRequest.Builder
Overrides

build()

public ListEntityTypesRequest build()
Returns
Type Description
ListEntityTypesRequest

buildPartial()

public ListEntityTypesRequest buildPartial()
Returns
Type Description
ListEntityTypesRequest

clear()

public ListEntityTypesRequest.Builder clear()
Returns
Type Description
ListEntityTypesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListEntityTypesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListEntityTypesRequest.Builder
Overrides

clearFilter()

public ListEntityTypesRequest.Builder clearFilter()

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
Type Description
ListEntityTypesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListEntityTypesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListEntityTypesRequest.Builder
Overrides

clearOrderBy()

public ListEntityTypesRequest.Builder clearOrderBy()

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
Type Description
ListEntityTypesRequest.Builder

This builder for chaining.

clearPageSize()

public ListEntityTypesRequest.Builder clearPageSize()

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
Type Description
ListEntityTypesRequest.Builder

This builder for chaining.

clearPageToken()

public ListEntityTypesRequest.Builder clearPageToken()

A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token.

string page_token = 4;

Returns
Type Description
ListEntityTypesRequest.Builder

This builder for chaining.

clearParent()

public ListEntityTypesRequest.Builder clearParent()

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
Type Description
ListEntityTypesRequest.Builder

This builder for chaining.

clearReadMask()

public ListEntityTypesRequest.Builder clearReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns
Type Description
ListEntityTypesRequest.Builder

clone()

public ListEntityTypesRequest.Builder clone()
Returns
Type Description
ListEntityTypesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListEntityTypesRequest getDefaultInstanceForType()
Returns
Type Description
ListEntityTypesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

public 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
Type Description
String

The filter.

getFilterBytes()

public 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
Type Description
ByteString

The bytes for filter.

getOrderBy()

public 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
Type Description
String

The orderBy.

getOrderByBytes()

public 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
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public 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
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token.

string page_token = 4;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token.

string page_token = 4;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public 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
Type Description
String

The parent.

getParentBytes()

public 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
Type Description
ByteString

The bytes for parent.

getReadMask()

public FieldMask getReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns
Type Description
FieldMask

The readMask.

getReadMaskBuilder()

public FieldMask.Builder getReadMaskBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns
Type Description
Builder

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns
Type Description
FieldMaskOrBuilder

hasReadMask()

public boolean hasReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns
Type Description
boolean

Whether the readMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListEntityTypesRequest other)

public ListEntityTypesRequest.Builder mergeFrom(ListEntityTypesRequest other)
Parameter
Name Description
other ListEntityTypesRequest
Returns
Type Description
ListEntityTypesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListEntityTypesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListEntityTypesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListEntityTypesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListEntityTypesRequest.Builder
Overrides

mergeReadMask(FieldMask value)

public ListEntityTypesRequest.Builder mergeReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Parameter
Name Description
value FieldMask
Returns
Type Description
ListEntityTypesRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListEntityTypesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListEntityTypesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListEntityTypesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListEntityTypesRequest.Builder
Overrides

setFilter(String value)

public ListEntityTypesRequest.Builder setFilter(String value)

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;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListEntityTypesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListEntityTypesRequest.Builder setFilterBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListEntityTypesRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListEntityTypesRequest.Builder setOrderBy(String value)

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;

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListEntityTypesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListEntityTypesRequest.Builder setOrderByBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListEntityTypesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListEntityTypesRequest.Builder setPageSize(int value)

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;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListEntityTypesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListEntityTypesRequest.Builder setPageToken(String value)

A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token.

string page_token = 4;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListEntityTypesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListEntityTypesRequest.Builder setPageTokenBytes(ByteString value)

A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token.

string page_token = 4;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListEntityTypesRequest.Builder

This builder for chaining.

setParent(String value)

public ListEntityTypesRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListEntityTypesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListEntityTypesRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListEntityTypesRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public ListEntityTypesRequest.Builder setReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Parameter
Name Description
value FieldMask
Returns
Type Description
ListEntityTypesRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListEntityTypesRequest.Builder setReadMask(FieldMask.Builder builderForValue)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ListEntityTypesRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListEntityTypesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListEntityTypesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListEntityTypesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListEntityTypesRequest.Builder
Overrides