com.google.cloud.aiplatform.v1

Interface ListContextsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListContextsRequest, ListContextsRequest.Builder

public interface ListContextsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

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) = { ... }

Returns:

The parent.

getParentBytes

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) = { ... }

Returns:

The bytes for parent.

getPageSize

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;

Returns:

The pageSize.

getPageToken

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;

Returns:

The pageToken.

getPageTokenBytes

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;

Returns:

The bytes for pageToken.

getFilter

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;

Returns:

The filter.

getFilterBytes

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;

Returns:

The bytes for filter.

getOrderBy

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;

Returns:

The orderBy.

getOrderByBytes

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;

Returns:

The bytes for orderBy.