Class ListFeaturestoresRequest (2.5.3) 

public final class ListFeaturestoresRequest extends GeneratedMessageV3 implements ListFeaturestoresRequestOrBuilder

Request message for FeaturestoreService.ListFeaturestores.

Protobuf type google.cloud.aiplatform.v1beta1.ListFeaturestoresRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ListFeaturestoresRequest

Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

READ_MASK_FIELD_NUMBER

public static final int READ_MASK_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstance()

public static ListFeaturestoresRequest getDefaultInstance()
Returns
TypeDescription
ListFeaturestoresRequest

getDefaultInstanceForType()

public ListFeaturestoresRequest getDefaultInstanceForType()
Returns
TypeDescription
ListFeaturestoresRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getFilter()

public String getFilter()

Lists the featurestores that match the filter expression. The following fields 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.
  • online_serving_config.fixed_node_count: Supports =, !=, <, >, <=, and >= comparisons.
  • labels: Supports key-value equality and key presence. Examples:
  • create_time > "2020-01-01" OR update_time > "2020-01-01" Featurestores created or updated after 2020-01-01.
  • labels.env = "prod" Featurestores with label "env" set to "prod".

string filter = 2;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Lists the featurestores that match the filter expression. The following fields 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.
  • online_serving_config.fixed_node_count: Supports =, !=, <, >, <=, and >= comparisons.
  • labels: Supports key-value equality and key presence. Examples:
  • create_time > "2020-01-01" OR update_time > "2020-01-01" Featurestores created or updated after 2020-01-01.
  • labels.env = "prod" Featurestores with label "env" set to "prod".

string filter = 2;

Returns
TypeDescription
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:

  • create_time
  • update_time
  • online_serving_config.fixed_node_count

string order_by = 5;

Returns
TypeDescription
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:

  • create_time
  • update_time
  • online_serving_config.fixed_node_count

string order_by = 5;

Returns
TypeDescription
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

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

int32 page_size = 3;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token.

string page_token = 4;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token.

string page_token = 4;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

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

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<ListFeaturestoresRequest> getParserForType()
Returns
TypeDescription
Parser<ListFeaturestoresRequest>
Overrides

getReadMask()

public FieldMask getReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns
TypeDescription
FieldMask

The readMask.

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns
TypeDescription
FieldMaskOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasReadMask()

public boolean hasReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns
TypeDescription
boolean

Whether the readMask field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static ListFeaturestoresRequest.Builder newBuilder()
Returns
TypeDescription
ListFeaturestoresRequest.Builder

newBuilder(ListFeaturestoresRequest prototype)

public static ListFeaturestoresRequest.Builder newBuilder(ListFeaturestoresRequest prototype)
Parameter
NameDescription
prototypeListFeaturestoresRequest
Returns
TypeDescription
ListFeaturestoresRequest.Builder

newBuilderForType()

public ListFeaturestoresRequest.Builder newBuilderForType()
Returns
TypeDescription
ListFeaturestoresRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListFeaturestoresRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ListFeaturestoresRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static ListFeaturestoresRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListFeaturestoresRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListFeaturestoresRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListFeaturestoresRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ListFeaturestoresRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ListFeaturestoresRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListFeaturestoresRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListFeaturestoresRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListFeaturestoresRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ListFeaturestoresRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListFeaturestoresRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListFeaturestoresRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListFeaturestoresRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ListFeaturestoresRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListFeaturestoresRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListFeaturestoresRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ListFeaturestoresRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListFeaturestoresRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListFeaturestoresRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListFeaturestoresRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ListFeaturestoresRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ListFeaturestoresRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListFeaturestoresRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListFeaturestoresRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ListFeaturestoresRequest> parser()
Returns
TypeDescription
Parser<ListFeaturestoresRequest>

toBuilder()

public ListFeaturestoresRequest.Builder toBuilder()
Returns
TypeDescription
ListFeaturestoresRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException