Package com.google.cloud.aiplatform.v1

Class ListModelsRequest

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ListModelsRequest.Builder
    Request message for [ModelService.ListModels][google.cloud.aiplatform.v1.ModelService.ListModels].

    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 ListModelsRequest
    getDefaultInstance()
     
    ListModelsRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.Parser<ListModelsRequest>
    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 ListModelsRequest.Builder
    newBuilder()
     
    static ListModelsRequest.Builder
    newBuilder(ListModelsRequest prototype)
     
    ListModelsRequest.Builder
    newBuilderForType()
     
    protected ListModelsRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static ListModelsRequest
    parseDelimitedFrom(InputStream input)
     
    static ListModelsRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListModelsRequest
    parseFrom(byte[] data)
     
    static ListModelsRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListModelsRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static ListModelsRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListModelsRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ListModelsRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListModelsRequest
    parseFrom(InputStream input)
     
    static ListModelsRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListModelsRequest
    parseFrom(ByteBuffer data)
     
    static ListModelsRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ListModelsRequest>
    parser()
     
    ListModelsRequest.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 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.

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

 Some examples:

 * `model=1234`
 * `displayName="myDisplayName"`
 * `labels.myKey="myValue"`
 * `baseModelName="text-bison"`
      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"`.
 * `base_model_name` only supports =

 Some examples:

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

    • getPageSize

      public int getPageSize()
       The standard list page size.
      int32 page_size = 3;
      Specified by:
      getPageSize in interface ListModelsRequestOrBuilder
      Returns:
      The pageSize.

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

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

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

    • 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 ListModelsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ListModelsRequest.Builder newBuilder()

    • newBuilder

      public static ListModelsRequest.Builder newBuilder(ListModelsRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ListModelsRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ListModelsRequest> 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 ListModelsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder