public final class ListContextsRequest extends GeneratedMessageV3 implements ListContextsRequestOrBuilder
Request message for
MetadataService.ListContexts
Protobuf type google.cloud.aiplatform.v1beta1.ListContextsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static ListContextsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListContextsRequest.Builder newBuilder()
newBuilder(ListContextsRequest prototype)
public static ListContextsRequest.Builder newBuilder(ListContextsRequest prototype)
parseDelimitedFrom(InputStream input)
public static ListContextsRequest parseDelimitedFrom(InputStream input)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListContextsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListContextsRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListContextsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListContextsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListContextsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
parseFrom(CodedInputStream input)
public static ListContextsRequest parseFrom(CodedInputStream input)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListContextsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(InputStream input)
public static ListContextsRequest parseFrom(InputStream input)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListContextsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListContextsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListContextsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListContextsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public ListContextsRequest getDefaultInstanceForType()
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;
| Returns |
|---|
| Type | Description |
String | The filter.
|
getFilterBytes()
public 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 |
|---|
| Type | Description |
ByteString | 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;
| Returns |
|---|
| Type | Description |
String | The orderBy.
|
getOrderByBytes()
public 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 |
|---|
| Type | Description |
ByteString | The bytes for orderBy.
|
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 |
|---|
| Type | Description |
int | The pageSize.
|
getPageToken()
public String getPageToken()
A page token, received from a previous
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 |
|---|
| Type | Description |
String | The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
A page token, received from a previous
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 |
|---|
| Type | Description |
ByteString | The bytes for pageToken.
|
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) = { ... }
| Returns |
|---|
| Type | Description |
String | The parent.
|
getParentBytes()
public 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 |
|---|
| Type | Description |
ByteString | The bytes for parent.
|
getParserForType()
public Parser<ListContextsRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListContextsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListContextsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public ListContextsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
