Package com.google.cloud.aiplatform.v1

Class ListEntityTypesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.ListEntityTypesRequest
All Implemented Interfaces:
ListEntityTypesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ListEntityTypesRequest extends com.google.protobuf.GeneratedMessage implements ListEntityTypesRequestOrBuilder
 Request message for
 [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes].
Protobuf type google.cloud.aiplatform.v1.ListEntityTypesRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ListEntityTypesRequest.Builder
    Request message for [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes].

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FILTER_FIELD_NUMBER
     
    static final int
    ORDER_BY_FIELD_NUMBER
     
    static final int
    PAGE_SIZE_FIELD_NUMBER
     
    static final int
    PAGE_TOKEN_FIELD_NUMBER
     
    static final int
    PARENT_FIELD_NUMBER
     
    static final int
    READ_MASK_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static ListEntityTypesRequest
    getDefaultInstance()
     
    ListEntityTypesRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.v1.FeaturestoreService.ListEntityTypes] call.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    A page token, received from a previous [FeaturestoreService.ListEntityTypes][google.cloud.aiplatform.v1.FeaturestoreService.ListEntityTypes] call.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    com.google.protobuf.Parser<ListEntityTypesRequest>
    getParserForType()
     
    com.google.protobuf.FieldMask
    getReadMask()
    Mask specifying which fields to read.
    com.google.protobuf.FieldMaskOrBuilder
    getReadMaskOrBuilder()
    Mask specifying which fields to read.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasReadMask()
    Mask specifying which fields to read.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ListEntityTypesRequest.Builder
    newBuilder()
     
    static ListEntityTypesRequest.Builder
    newBuilder(ListEntityTypesRequest prototype)
     
    ListEntityTypesRequest.Builder
    newBuilderForType()
     
    protected ListEntityTypesRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static ListEntityTypesRequest
    parseDelimitedFrom(InputStream input)
     
    static ListEntityTypesRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListEntityTypesRequest
    parseFrom(byte[] data)
     
    static ListEntityTypesRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListEntityTypesRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static ListEntityTypesRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListEntityTypesRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ListEntityTypesRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListEntityTypesRequest
    parseFrom(InputStream input)
     
    static ListEntityTypesRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListEntityTypesRequest
    parseFrom(ByteBuffer data)
     
    static ListEntityTypesRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ListEntityTypesRequest>
    parser()
     
    ListEntityTypesRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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) = { ... }
      Specified by:
      getParent in interface ListEntityTypesRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public 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) = { ... }
      Specified by:
      getParentBytes in interface ListEntityTypesRequestOrBuilder
      Returns:
      The bytes for parent.

    • 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;
      Specified by:
      getFilter in interface ListEntityTypesRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public 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;
      Specified by:
      getFilterBytes in interface ListEntityTypesRequestOrBuilder
      Returns:
      The bytes for filter.

    • 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;
      Specified by:
      getPageSize in interface ListEntityTypesRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

      public String getPageToken()
       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.
      string page_token = 4;
      Specified by:
      getPageToken in interface ListEntityTypesRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       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.
      string page_token = 4;
      Specified by:
      getPageTokenBytes in interface ListEntityTypesRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • 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;
      Specified by:
      getOrderBy in interface ListEntityTypesRequestOrBuilder
      Returns:
      The orderBy.

    • getOrderByBytes

      public 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;
      Specified by:
      getOrderByBytes in interface ListEntityTypesRequestOrBuilder
      Returns:
      The bytes for orderBy.

    • hasReadMask

      public boolean hasReadMask()
       Mask specifying which fields to read.
      .google.protobuf.FieldMask read_mask = 6;
      Specified by:
      hasReadMask in interface ListEntityTypesRequestOrBuilder
      Returns:
      Whether the readMask field is set.

    • getReadMask

      public com.google.protobuf.FieldMask getReadMask()
       Mask specifying which fields to read.
      .google.protobuf.FieldMask read_mask = 6;
      Specified by:
      getReadMask in interface ListEntityTypesRequestOrBuilder
      Returns:
      The readMask.

    • getReadMaskOrBuilder

      public com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
       Mask specifying which fields to read.
      .google.protobuf.FieldMask read_mask = 6;
      Specified by:
      getReadMaskOrBuilder in interface ListEntityTypesRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ListEntityTypesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListEntityTypesRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListEntityTypesRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListEntityTypesRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListEntityTypesRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListEntityTypesRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListEntityTypesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListEntityTypesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListEntityTypesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListEntityTypesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListEntityTypesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListEntityTypesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ListEntityTypesRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ListEntityTypesRequest.Builder newBuilder()

    • newBuilder

      public static ListEntityTypesRequest.Builder newBuilder(ListEntityTypesRequest prototype)

    • toBuilder

      public ListEntityTypesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ListEntityTypesRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ListEntityTypesRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ListEntityTypesRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<ListEntityTypesRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ListEntityTypesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder