Package com.google.cloud.aiplatform.v1

Class ListModelsRequest.Builder

  • All Implemented Interfaces:
    ListModelsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    ListModelsRequest
    public static final class ListModelsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ListModelsRequest.Builder>
implements ListModelsRequestOrBuilder
     Request message for
 [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels].
    Protobuf type google.cloud.aiplatform.v1.ListModelsRequest

    • Method Detail

      • 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.Builder<ListModelsRequest.Builder>

      • clear

        public ListModelsRequest.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<ListModelsRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListModelsRequest.Builder>

      • getDefaultInstanceForType

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

      • build

        public ListModelsRequest build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public ListModelsRequest buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public ListModelsRequest.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ListModelsRequest.Builder>

      • setField

        public ListModelsRequest.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListModelsRequest.Builder>

      • clearField

        public ListModelsRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListModelsRequest.Builder>

      • clearOneof

        public ListModelsRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListModelsRequest.Builder>

      • setRepeatedField

        public ListModelsRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  int index,
                                                  Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListModelsRequest.Builder>

      • addRepeatedField

        public ListModelsRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListModelsRequest.Builder>

      • mergeFrom

        public ListModelsRequest.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListModelsRequest.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListModelsRequest.Builder>

      • mergeFrom

        public ListModelsRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListModelsRequest.Builder>
        Throws:
        IOException

      • getParent

        public String getParent()
         Required. The resource name of the Location to list the Models from.
 Format: `projects/{project}/locations/{location}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface ListModelsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The resource name of the Location to list the Models from.
 Format: `projects/{project}/locations/{location}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface ListModelsRequestOrBuilder
        Returns:
        The bytes for parent.

      • setParent

        public ListModelsRequest.Builder setParent​(String value)
         Required. The resource name of the Location to list the Models from.
 Format: `projects/{project}/locations/{location}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The parent to set.
        Returns:
        This builder for chaining.

      • clearParent

        public ListModelsRequest.Builder clearParent()
         Required. The resource name of the Location to list the Models from.
 Format: `projects/{project}/locations/{location}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setParentBytes

        public ListModelsRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         Required. The resource name of the Location to list the Models from.
 Format: `projects/{project}/locations/{location}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for parent to set.
        Returns:
        This builder for chaining.

      • getFilter

        public String getFilter()
         An expression for filtering the results of the request. For field names
 both snake_case and camelCase are supported.

   * `model` supports = and !=. `model` represents the Model ID,
     i.e. the last segment of the Model's [resource
     name][google.cloud.aiplatform.v1.Model.name].
   * `display_name` supports = and !=
   * `labels` supports general map functions that is:
     * `labels.key=value` - key:value equality
     * `labels.key:* or labels:key - key existence
     * A key including a space must be quoted. `labels."a key"`.

 Some examples:

   * `model=1234`
   * `displayName="myDisplayName"`
   * `labels.myKey="myValue"`
        string filter = 2;
        Specified by:
        getFilter in interface ListModelsRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         An expression for filtering the results of the request. For field names
 both snake_case and camelCase are supported.

   * `model` supports = and !=. `model` represents the Model ID,
     i.e. the last segment of the Model's [resource
     name][google.cloud.aiplatform.v1.Model.name].
   * `display_name` supports = and !=
   * `labels` supports general map functions that is:
     * `labels.key=value` - key:value equality
     * `labels.key:* or labels:key - key existence
     * A key including a space must be quoted. `labels."a key"`.

 Some examples:

   * `model=1234`
   * `displayName="myDisplayName"`
   * `labels.myKey="myValue"`
        string filter = 2;
        Specified by:
        getFilterBytes in interface ListModelsRequestOrBuilder
        Returns:
        The bytes for filter.

      • setFilter

        public ListModelsRequest.Builder setFilter​(String value)
         An expression for filtering the results of the request. For field names
 both snake_case and camelCase are supported.

   * `model` supports = and !=. `model` represents the Model ID,
     i.e. the last segment of the Model's [resource
     name][google.cloud.aiplatform.v1.Model.name].
   * `display_name` supports = and !=
   * `labels` supports general map functions that is:
     * `labels.key=value` - key:value equality
     * `labels.key:* or labels:key - key existence
     * A key including a space must be quoted. `labels."a key"`.

 Some examples:

   * `model=1234`
   * `displayName="myDisplayName"`
   * `labels.myKey="myValue"`
        string filter = 2;
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.

      • clearFilter

        public ListModelsRequest.Builder clearFilter()
         An expression for filtering the results of the request. For field names
 both snake_case and camelCase are supported.

   * `model` supports = and !=. `model` represents the Model ID,
     i.e. the last segment of the Model's [resource
     name][google.cloud.aiplatform.v1.Model.name].
   * `display_name` supports = and !=
   * `labels` supports general map functions that is:
     * `labels.key=value` - key:value equality
     * `labels.key:* or labels:key - key existence
     * A key including a space must be quoted. `labels."a key"`.

 Some examples:

   * `model=1234`
   * `displayName="myDisplayName"`
   * `labels.myKey="myValue"`
        string filter = 2;
        Returns:
        This builder for chaining.

      • setFilterBytes

        public ListModelsRequest.Builder setFilterBytes​(com.google.protobuf.ByteString value)
         An expression for filtering the results of the request. For field names
 both snake_case and camelCase are supported.

   * `model` supports = and !=. `model` represents the Model ID,
     i.e. the last segment of the Model's [resource
     name][google.cloud.aiplatform.v1.Model.name].
   * `display_name` supports = and !=
   * `labels` supports general map functions that is:
     * `labels.key=value` - key:value equality
     * `labels.key:* or labels:key - key existence
     * A key including a space must be quoted. `labels."a key"`.

 Some examples:

   * `model=1234`
   * `displayName="myDisplayName"`
   * `labels.myKey="myValue"`
        string filter = 2;
        Parameters:
        value - The bytes for filter to set.
        Returns:
        This builder for chaining.

      • setPageSize

        public ListModelsRequest.Builder setPageSize​(int value)
         The standard list page size.
        int32 page_size = 3;
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.

      • clearPageSize

        public ListModelsRequest.Builder clearPageSize()
         The standard list page size.
        int32 page_size = 3;
        Returns:
        This builder for chaining.

      • getPageToken

        public String getPageToken()
         The standard list page token.
 Typically obtained via
 [ListModelsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelsResponse.next_page_token]
 of the previous
 [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels]
 call.
        string page_token = 4;
        Specified by:
        getPageToken in interface ListModelsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         The standard list page token.
 Typically obtained via
 [ListModelsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelsResponse.next_page_token]
 of the previous
 [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels]
 call.
        string page_token = 4;
        Specified by:
        getPageTokenBytes in interface ListModelsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • setPageToken

        public ListModelsRequest.Builder setPageToken​(String value)
         The standard list page token.
 Typically obtained via
 [ListModelsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelsResponse.next_page_token]
 of the previous
 [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels]
 call.
        string page_token = 4;
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.

      • clearPageToken

        public ListModelsRequest.Builder clearPageToken()
         The standard list page token.
 Typically obtained via
 [ListModelsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelsResponse.next_page_token]
 of the previous
 [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels]
 call.
        string page_token = 4;
        Returns:
        This builder for chaining.

      • setPageTokenBytes

        public ListModelsRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         The standard list page token.
 Typically obtained via
 [ListModelsResponse.next_page_token][google.cloud.aiplatform.v1.ListModelsResponse.next_page_token]
 of the previous
 [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels]
 call.
        string page_token = 4;
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.

      • hasReadMask

        public boolean hasReadMask()
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5;
        Specified by:
        hasReadMask in interface ListModelsRequestOrBuilder
        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 = 5;
        Specified by:
        getReadMask in interface ListModelsRequestOrBuilder
        Returns:
        The readMask.

      • setReadMask

        public ListModelsRequest.Builder setReadMask​(com.google.protobuf.FieldMask value)
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5;

      • setReadMask

        public ListModelsRequest.Builder setReadMask​(com.google.protobuf.FieldMask.Builder builderForValue)
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5;

      • mergeReadMask

        public ListModelsRequest.Builder mergeReadMask​(com.google.protobuf.FieldMask value)
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5;

      • clearReadMask

        public ListModelsRequest.Builder clearReadMask()
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5;

      • getReadMaskBuilder

        public com.google.protobuf.FieldMask.Builder getReadMaskBuilder()
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5;

      • getReadMaskOrBuilder

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

      • 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:

   * `display_name`
   * `create_time`
   * `update_time`

 Example: `display_name, create_time desc`.
        string order_by = 6;
        Specified by:
        getOrderBy in interface ListModelsRequestOrBuilder
        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:

   * `display_name`
   * `create_time`
   * `update_time`

 Example: `display_name, create_time desc`.
        string order_by = 6;
        Specified by:
        getOrderByBytes in interface ListModelsRequestOrBuilder
        Returns:
        The bytes for orderBy.

      • setOrderBy

        public ListModelsRequest.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:

   * `display_name`
   * `create_time`
   * `update_time`

 Example: `display_name, create_time desc`.
        string order_by = 6;
        Parameters:
        value - The orderBy to set.
        Returns:
        This builder for chaining.

      • clearOrderBy

        public ListModelsRequest.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:

   * `display_name`
   * `create_time`
   * `update_time`

 Example: `display_name, create_time desc`.
        string order_by = 6;
        Returns:
        This builder for chaining.

      • setOrderByBytes

        public ListModelsRequest.Builder setOrderByBytes​(com.google.protobuf.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:

   * `display_name`
   * `create_time`
   * `update_time`

 Example: `display_name, create_time desc`.
        string order_by = 6;
        Parameters:
        value - The bytes for orderBy to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final ListModelsRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListModelsRequest.Builder>

      • mergeUnknownFields

        public final ListModelsRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListModelsRequest.Builder>