Class FetchExamplesRequest (3.77.0)
public final class FetchExamplesRequest extends GeneratedMessageV3 implements FetchExamplesRequestOrBuilder
Request message for
ExampleStoreService.FetchExamples.
Protobuf type google.cloud.aiplatform.v1beta1.FetchExamplesRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int EXAMPLE_IDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int EXAMPLE_STORE_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 |
|
STORED_CONTENTS_EXAMPLE_FILTER_FIELD_NUMBER
public static final int STORED_CONTENTS_EXAMPLE_FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static FetchExamplesRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static FetchExamplesRequest.Builder newBuilder()
public static FetchExamplesRequest.Builder newBuilder(FetchExamplesRequest prototype)
public static FetchExamplesRequest parseDelimitedFrom(InputStream input)
public static FetchExamplesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static FetchExamplesRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static FetchExamplesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static FetchExamplesRequest parseFrom(ByteString data)
public static FetchExamplesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FetchExamplesRequest parseFrom(CodedInputStream input)
public static FetchExamplesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static FetchExamplesRequest parseFrom(InputStream input)
public static FetchExamplesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static FetchExamplesRequest parseFrom(ByteBuffer data)
public static FetchExamplesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<FetchExamplesRequest> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public FetchExamplesRequest getDefaultInstanceForType()
public String getExampleIds(int index)
Optional. Example IDs to fetch. If both metadata filters and Example IDs
are specified, then both ID and metadata filtering will be applied.
repeated string example_ids = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The exampleIds at the given index.
|
public ByteString getExampleIdsBytes(int index)
Optional. Example IDs to fetch. If both metadata filters and Example IDs
are specified, then both ID and metadata filtering will be applied.
repeated string example_ids = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the exampleIds at the given index.
|
public int getExampleIdsCount()
Optional. Example IDs to fetch. If both metadata filters and Example IDs
are specified, then both ID and metadata filtering will be applied.
repeated string example_ids = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The count of exampleIds.
|
public ProtocolStringList getExampleIdsList()
Optional. Example IDs to fetch. If both metadata filters and Example IDs
are specified, then both ID and metadata filtering will be applied.
repeated string example_ids = 6 [(.google.api.field_behavior) = OPTIONAL];
public String getExampleStore()
Required. The name of the ExampleStore resource that the examples should be
fetched from. Format:
projects/{project}/locations/{location}/exampleStores/{example_store}
string example_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The exampleStore.
|
public ByteString getExampleStoreBytes()
Required. The name of the ExampleStore resource that the examples should be
fetched from. Format:
projects/{project}/locations/{location}/exampleStores/{example_store}
string example_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for exampleStore.
|
public FetchExamplesRequest.MetadataFilterCase getMetadataFilterCase()
getPageSize()
Optional. The maximum number of examples to return. The service may return
fewer than this value. If unspecified, at most 100 examples will be
returned.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The pageSize.
|
getPageToken()
public String getPageToken()
Optional. The
next_page_token
value returned from a previous list
[ExampleStoreService.FetchExamplesResponse][] call.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
Optional. The
next_page_token
value returned from a previous list
[ExampleStoreService.FetchExamplesResponse][] call.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for pageToken.
|
public Parser<FetchExamplesRequest> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getStoredContentsExampleFilter()
public StoredContentsExampleFilter getStoredContentsExampleFilter()
The metadata filters for StoredContentsExamples.
.google.cloud.aiplatform.v1beta1.StoredContentsExampleFilter stored_contents_example_filter = 8;
getStoredContentsExampleFilterOrBuilder()
public StoredContentsExampleFilterOrBuilder getStoredContentsExampleFilterOrBuilder()
The metadata filters for StoredContentsExamples.
.google.cloud.aiplatform.v1beta1.StoredContentsExampleFilter stored_contents_example_filter = 8;
hasStoredContentsExampleFilter()
public boolean hasStoredContentsExampleFilter()
The metadata filters for StoredContentsExamples.
.google.cloud.aiplatform.v1beta1.StoredContentsExampleFilter stored_contents_example_filter = 8;
| Returns |
| Type |
Description |
boolean |
Whether the storedContentsExampleFilter field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public FetchExamplesRequest.Builder newBuilderForType()
protected FetchExamplesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public FetchExamplesRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-11 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]
