Package com.google.cloud.aiplatform.v1

Class ListContextsRequest

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ListContextsRequest.Builder
    Request message for [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts]

    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
     

    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 ListContextsRequest
    getDefaultInstance()
     
    ListContextsRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getFilter()
    Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set.
    com.google.protobuf.ByteString
    getFilterBytes()
    Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set.
    String
    getOrderBy()
    How the list of messages is ordered.
    com.google.protobuf.ByteString
    getOrderByBytes()
    How the list of messages is ordered.
    int
    getPageSize()
    The maximum number of Contexts to return.
    String
    getPageToken()
    A page token, received from a previous [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts] call.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    A page token, received from a previous [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts] call.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    com.google.protobuf.Parser<ListContextsRequest>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ListContextsRequest.Builder
    newBuilder()
     
    static ListContextsRequest.Builder
    newBuilder(ListContextsRequest prototype)
     
    ListContextsRequest.Builder
    newBuilderForType()
     
    protected ListContextsRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static ListContextsRequest
    parseDelimitedFrom(InputStream input)
     
    static ListContextsRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListContextsRequest
    parseFrom(byte[] data)
     
    static ListContextsRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListContextsRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static ListContextsRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListContextsRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ListContextsRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListContextsRequest
    parseFrom(InputStream input)
     
    static ListContextsRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListContextsRequest
    parseFrom(ByteBuffer data)
     
    static ListContextsRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ListContextsRequest>
    parser()
     
    ListContextsRequest.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 MetadataStore whose Contexts should be listed.
 Format:
 `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface ListContextsRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The MetadataStore whose Contexts should be listed.
 Format:
 `projects/{project}/locations/{location}/metadataStores/{metadatastore}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface ListContextsRequestOrBuilder
      Returns:
      The bytes for parent.

    • getPageSize

      public int getPageSize()
       The maximum number of Contexts to return. The service may return fewer.
 Must be in range 1-1000, inclusive. Defaults to 100.
      int32 page_size = 2;
      Specified by:
      getPageSize in interface ListContextsRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

      public String getPageToken()
       A page token, received from a previous
 [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other provided parameters must match the call that
 provided the page token. (Otherwise the request will fail with
 INVALID_ARGUMENT error.)
      string page_token = 3;
      Specified by:
      getPageToken in interface ListContextsRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       A page token, received from a previous
 [MetadataService.ListContexts][google.cloud.aiplatform.v1.MetadataService.ListContexts]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other provided parameters must match the call that
 provided the page token. (Otherwise the request will fail with
 INVALID_ARGUMENT error.)
      string page_token = 3;
      Specified by:
      getPageTokenBytes in interface ListContextsRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • getFilter

      public String getFilter()
       Filter specifying the boolean condition for the Contexts to satisfy in
 order to be part of the result set.
 The syntax to define filter query is based on https://google.aip.dev/160.
 Following are the supported set of filters:

 *  **Attribute filtering**:
 For example: `display_name = "test"`.
 Supported fields include: `name`, `display_name`, `schema_title`,
 `create_time`, and `update_time`.
 Time fields, such as `create_time` and `update_time`, require values
 specified in RFC-3339 format.
 For example: `create_time = "2020-11-19T11:30:00-04:00"`.
 *  **Metadata field**:
 To filter on metadata fields use traversal operation as follows:
 `metadata.<field_name>.<type_value>`.
 For example: `metadata.field_1.number_value = 10.0`.
 In case the field name contains special characters (such as colon), one
 can embed it inside double quote.
 For example: `metadata."field:1".number_value = 10.0`
 *  **Parent Child filtering**:
 To filter Contexts based on parent-child relationship use the HAS
 operator as follows:

 ```
 parent_contexts:
 "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>"
 child_contexts:
 "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>"
 ```

 Each of the above supported filters can be combined together using
 logical operators (`AND` & `OR`). Maximum nested expression depth allowed
 is 5.

 For example: `display_name = "test" AND metadata.field1.bool_value = true`.
      string filter = 4;
      Specified by:
      getFilter in interface ListContextsRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       Filter specifying the boolean condition for the Contexts to satisfy in
 order to be part of the result set.
 The syntax to define filter query is based on https://google.aip.dev/160.
 Following are the supported set of filters:

 *  **Attribute filtering**:
 For example: `display_name = "test"`.
 Supported fields include: `name`, `display_name`, `schema_title`,
 `create_time`, and `update_time`.
 Time fields, such as `create_time` and `update_time`, require values
 specified in RFC-3339 format.
 For example: `create_time = "2020-11-19T11:30:00-04:00"`.
 *  **Metadata field**:
 To filter on metadata fields use traversal operation as follows:
 `metadata.<field_name>.<type_value>`.
 For example: `metadata.field_1.number_value = 10.0`.
 In case the field name contains special characters (such as colon), one
 can embed it inside double quote.
 For example: `metadata."field:1".number_value = 10.0`
 *  **Parent Child filtering**:
 To filter Contexts based on parent-child relationship use the HAS
 operator as follows:

 ```
 parent_contexts:
 "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>"
 child_contexts:
 "projects/<project_number>/locations/<location>/metadataStores/<metadatastore_name>/contexts/<context_id>"
 ```

 Each of the above supported filters can be combined together using
 logical operators (`AND` & `OR`). Maximum nested expression depth allowed
 is 5.

 For example: `display_name = "test" AND metadata.field1.bool_value = true`.
      string filter = 4;
      Specified by:
      getFilterBytes in interface ListContextsRequestOrBuilder
      Returns:
      The bytes for filter.

    • getOrderBy

      public String getOrderBy()
       How the list of messages is ordered. Specify the values to order by and an
 ordering operation. The default sorting order is ascending. To specify
 descending order for a field, users append a " desc" suffix; for example:
 "foo desc, bar".
 Subfields are specified with a `.` character, such as foo.bar.
 see https://google.aip.dev/132#ordering for more details.
      string order_by = 5;
      Specified by:
      getOrderBy in interface ListContextsRequestOrBuilder
      Returns:
      The orderBy.

    • getOrderByBytes

      public com.google.protobuf.ByteString getOrderByBytes()
       How the list of messages is ordered. Specify the values to order by and an
 ordering operation. The default sorting order is ascending. To specify
 descending order for a field, users append a " desc" suffix; for example:
 "foo desc, bar".
 Subfields are specified with a `.` character, such as foo.bar.
 see https://google.aip.dev/132#ordering for more details.
      string order_by = 5;
      Specified by:
      getOrderByBytes in interface ListContextsRequestOrBuilder
      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 ListContextsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ListContextsRequest.Builder newBuilder()

    • newBuilder

      public static ListContextsRequest.Builder newBuilder(ListContextsRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ListContextsRequest getDefaultInstance()

    • parser

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

    • getParserForType

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