public static final class ListContextsRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ListContextsRequest.Builder> implements ListContextsRequestOrBuilder
Request message for [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.MetadataService.ListContexts]Protobuf type
google.cloud.aiplatform.v1beta1.ListContextsRequest| Modifier and Type | Method and Description |
|---|---|
ListContextsRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ListContextsRequest |
build() |
ListContextsRequest |
buildPartial() |
ListContextsRequest.Builder |
clear() |
ListContextsRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
ListContextsRequest.Builder |
clearFilter()
Filter specifying the boolean condition for the Contexts to satisfy in
order to be part of the result set.
|
ListContextsRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
ListContextsRequest.Builder |
clearOrderBy()
How the list of messages is ordered.
|
ListContextsRequest.Builder |
clearPageSize()
The maximum number of Contexts to return.
|
ListContextsRequest.Builder |
clearPageToken()
A page token, received from a previous
[MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.MetadataService.ListContexts]
call.
|
ListContextsRequest.Builder |
clearParent()
Required.
|
ListContextsRequest.Builder |
clone() |
ListContextsRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
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.v1beta1.MetadataService.ListContexts]
call.
|
com.google.protobuf.ByteString |
getPageTokenBytes()
A page token, received from a previous
[MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.MetadataService.ListContexts]
call.
|
String |
getParent()
Required.
|
com.google.protobuf.ByteString |
getParentBytes()
Required.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
ListContextsRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
ListContextsRequest.Builder |
mergeFrom(ListContextsRequest other) |
ListContextsRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
ListContextsRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
ListContextsRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ListContextsRequest.Builder |
setFilter(String value)
Filter specifying the boolean condition for the Contexts to satisfy in
order to be part of the result set.
|
ListContextsRequest.Builder |
setFilterBytes(com.google.protobuf.ByteString value)
Filter specifying the boolean condition for the Contexts to satisfy in
order to be part of the result set.
|
ListContextsRequest.Builder |
setOrderBy(String value)
How the list of messages is ordered.
|
ListContextsRequest.Builder |
setOrderByBytes(com.google.protobuf.ByteString value)
How the list of messages is ordered.
|
ListContextsRequest.Builder |
setPageSize(int value)
The maximum number of Contexts to return.
|
ListContextsRequest.Builder |
setPageToken(String value)
A page token, received from a previous
[MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.MetadataService.ListContexts]
call.
|
ListContextsRequest.Builder |
setPageTokenBytes(com.google.protobuf.ByteString value)
A page token, received from a previous
[MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.MetadataService.ListContexts]
call.
|
ListContextsRequest.Builder |
setParent(String value)
Required.
|
ListContextsRequest.Builder |
setParentBytes(com.google.protobuf.ByteString value)
Required.
|
ListContextsRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
ListContextsRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListContextsRequest.Builder>public ListContextsRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<ListContextsRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListContextsRequest.Builder>public ListContextsRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic ListContextsRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic ListContextsRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic ListContextsRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<ListContextsRequest.Builder>public ListContextsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<ListContextsRequest.Builder>public ListContextsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListContextsRequest.Builder>public ListContextsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListContextsRequest.Builder>public ListContextsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListContextsRequest.Builder>public ListContextsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListContextsRequest.Builder>public ListContextsRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListContextsRequest.Builder>public ListContextsRequest.Builder mergeFrom(ListContextsRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListContextsRequest.Builder>public ListContextsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListContextsRequest.Builder>IOExceptionpublic 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) = { ... }
getParent in interface ListContextsRequestOrBuilderpublic 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) = { ... }
getParentBytes in interface ListContextsRequestOrBuilderpublic ListContextsRequest.Builder setParent(String value)
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) = { ... }
value - The parent to set.public ListContextsRequest.Builder clearParent()
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) = { ... }
public ListContextsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
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) = { ... }
value - The bytes for parent to set.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;getPageSize in interface ListContextsRequestOrBuilderpublic ListContextsRequest.Builder setPageSize(int value)
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;value - The pageSize to set.public ListContextsRequest.Builder clearPageSize()
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;public String getPageToken()
A page token, received from a previous [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.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;getPageToken in interface ListContextsRequestOrBuilderpublic com.google.protobuf.ByteString getPageTokenBytes()
A page token, received from a previous [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.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;getPageTokenBytes in interface ListContextsRequestOrBuilderpublic ListContextsRequest.Builder setPageToken(String value)
A page token, received from a previous [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.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;value - The pageToken to set.public ListContextsRequest.Builder clearPageToken()
A page token, received from a previous [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.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;public ListContextsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
A page token, received from a previous [MetadataService.ListContexts][google.cloud.aiplatform.v1beta1.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;value - The bytes for pageToken to set.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;getFilter in interface ListContextsRequestOrBuilderpublic 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;getFilterBytes in interface ListContextsRequestOrBuilderpublic ListContextsRequest.Builder setFilter(String value)
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;value - The filter to set.public ListContextsRequest.Builder clearFilter()
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;public ListContextsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
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;value - The bytes for filter to set.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;getOrderBy in interface ListContextsRequestOrBuilderpublic 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;getOrderByBytes in interface ListContextsRequestOrBuilderpublic ListContextsRequest.Builder setOrderBy(String value)
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;value - The orderBy to set.public ListContextsRequest.Builder clearOrderBy()
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;public ListContextsRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)
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;value - The bytes for orderBy to set.public final ListContextsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListContextsRequest.Builder>public final ListContextsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListContextsRequest.Builder>Copyright © 2025 Google LLC. All rights reserved.