Interface FetchExamplesRequestOrBuilder (3.64.0)

public interface FetchExamplesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getExampleIds(int index)

public abstract 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.

getExampleIdsBytes(int index)

public abstract 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.

getExampleIdsCount()

public abstract 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.

getExampleIdsList()

public abstract List<String> 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];

Returns
Type Description
List<String>

A list containing the exampleIds.

getExampleStore()

public abstract 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.

getExampleStoreBytes()

public abstract 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.

getMetadataFilterCase()

public abstract FetchExamplesRequest.MetadataFilterCase getMetadataFilterCase()
Returns
Type Description
FetchExamplesRequest.MetadataFilterCase

getPageSize()

public abstract int 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 abstract 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 abstract 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.

getStoredContentsExampleFilter()

public abstract StoredContentsExampleFilter getStoredContentsExampleFilter()

The metadata filters for StoredContentsExamples.

.google.cloud.aiplatform.v1beta1.StoredContentsExampleFilter stored_contents_example_filter = 8;

Returns
Type Description
StoredContentsExampleFilter

The storedContentsExampleFilter.

getStoredContentsExampleFilterOrBuilder()

public abstract StoredContentsExampleFilterOrBuilder getStoredContentsExampleFilterOrBuilder()

The metadata filters for StoredContentsExamples.

.google.cloud.aiplatform.v1beta1.StoredContentsExampleFilter stored_contents_example_filter = 8;

Returns
Type Description
StoredContentsExampleFilterOrBuilder

hasStoredContentsExampleFilter()

public abstract 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.