Package com.google.cloud.aiplatform.v1

Interface ListModelsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListModelsRequest, ListModelsRequest.Builder
@Generated public interface ListModelsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    An expression for filtering the results of the request.
    com.google.protobuf.ByteString
    getFilterBytes()
    An expression for filtering the results of the request.
    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 standard list page size.
    String
    getPageToken()
    The standard list page token.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    The standard list page token.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    com.google.protobuf.FieldMask
    getReadMask()
    Mask specifying which fields to read.
    com.google.protobuf.FieldMaskOrBuilder
    getReadMaskOrBuilder()
    Mask specifying which fields to read.
    boolean
    hasReadMask()
    Mask specifying which fields to read.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getParent

      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) = { ... }
      Returns:
      The parent.

    • getParentBytes

      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) = { ... }
      Returns:
      The bytes for parent.

    • getFilter

      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"`.
 * `base_model_name` only supports =

 Some examples:

 * `model=1234`
 * `displayName="myDisplayName"`
 * `labels.myKey="myValue"`
 * `baseModelName="text-bison"`
      string filter = 2;
      Returns:
      The filter.

    • getFilterBytes

      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"`.
 * `base_model_name` only supports =

 Some examples:

 * `model=1234`
 * `displayName="myDisplayName"`
 * `labels.myKey="myValue"`
 * `baseModelName="text-bison"`
      string filter = 2;
      Returns:
      The bytes for filter.

    • getPageSize

      int getPageSize()
       The standard list page size.
      int32 page_size = 3;
      Returns:
      The pageSize.

    • getPageToken

      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;
      Returns:
      The pageToken.

    • getPageTokenBytes

      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;
      Returns:
      The bytes for pageToken.

    • hasReadMask

      boolean hasReadMask()
       Mask specifying which fields to read.
      .google.protobuf.FieldMask read_mask = 5;
      Returns:
      Whether the readMask field is set.

    • getReadMask

      com.google.protobuf.FieldMask getReadMask()
       Mask specifying which fields to read.
      .google.protobuf.FieldMask read_mask = 5;
      Returns:
      The readMask.

    • getReadMaskOrBuilder

      com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
       Mask specifying which fields to read.
      .google.protobuf.FieldMask read_mask = 5;

    • getOrderBy

      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;
      Returns:
      The orderBy.

    • getOrderByBytes

      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;
      Returns:
      The bytes for orderBy.