Class ListFeaturestoresRequest

  • All Implemented Interfaces:
    ListFeaturestoresRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class ListFeaturestoresRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements ListFeaturestoresRequestOrBuilder
     Request message for
     [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores].
     
    Protobuf type google.cloud.aiplatform.v1.ListFeaturestoresRequest
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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) = { ... }
        Specified by:
        getParent in interface ListFeaturestoresRequestOrBuilder
        Returns:
        The parent.
      • getParentBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getParentBytes in interface ListFeaturestoresRequestOrBuilder
        Returns:
        The bytes for parent.
      • 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;
        Specified by:
        getFilter in interface ListFeaturestoresRequestOrBuilder
        Returns:
        The filter.
      • getFilterBytes

        public com.google.protobuf.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;
        Specified by:
        getFilterBytes in interface ListFeaturestoresRequestOrBuilder
        Returns:
        The bytes for filter.
      • 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;
        Specified by:
        getPageSize in interface ListFeaturestoresRequestOrBuilder
        Returns:
        The pageSize.
      • getPageToken

        public String getPageToken()
         A page token, received from a previous
         [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores]
         call. Provide this to retrieve the subsequent page.
        
         When paginating, all other parameters provided to
         [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores]
         must match the call that provided the page token.
         
        string page_token = 4;
        Specified by:
        getPageToken in interface ListFeaturestoresRequestOrBuilder
        Returns:
        The pageToken.
      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         A page token, received from a previous
         [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores]
         call. Provide this to retrieve the subsequent page.
        
         When paginating, all other parameters provided to
         [FeaturestoreService.ListFeaturestores][google.cloud.aiplatform.v1.FeaturestoreService.ListFeaturestores]
         must match the call that provided the page token.
         
        string page_token = 4;
        Specified by:
        getPageTokenBytes in interface ListFeaturestoresRequestOrBuilder
        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:
        
           * `create_time`
           * `update_time`
           * `online_serving_config.fixed_node_count`
         
        string order_by = 5;
        Specified by:
        getOrderBy in interface ListFeaturestoresRequestOrBuilder
        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:
        
           * `create_time`
           * `update_time`
           * `online_serving_config.fixed_node_count`
         
        string order_by = 5;
        Specified by:
        getOrderByBytes in interface ListFeaturestoresRequestOrBuilder
        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 ListFeaturestoresRequestOrBuilder
        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 ListFeaturestoresRequestOrBuilder
        Returns:
        The readMask.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • 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 ListFeaturestoresRequest parseFrom​(ByteBuffer data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static ListFeaturestoresRequest parseFrom​(com.google.protobuf.ByteString data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

        protected ListFeaturestoresRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<ListFeaturestoresRequest> 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.GeneratedMessageV3
      • getDefaultInstanceForType

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