com.google.cloud.aiplatform.v1beta1

Interface FetchExamplesRequestOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

FetchExamplesRequest, FetchExamplesRequest.Builder

public interface FetchExamplesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getExampleIds(int index) Optional.
com.google.protobuf.ByteString	getExampleIdsBytes(int index) Optional.
int	getExampleIdsCount() Optional.
List<String>	getExampleIdsList() Optional.
String	getExampleStore() Required.
com.google.protobuf.ByteString	getExampleStoreBytes() Required.
FetchExamplesRequest.MetadataFilterCase	getMetadataFilterCase()
int	getPageSize() Optional.
String	getPageToken() Optional.
com.google.protobuf.ByteString	getPageTokenBytes() Optional.
StoredContentsExampleFilter	getStoredContentsExampleFilter() The metadata filters for StoredContentsExamples.
StoredContentsExampleFilterOrBuilder	getStoredContentsExampleFilterOrBuilder() The metadata filters for StoredContentsExamples.
boolean	hasStoredContentsExampleFilter() The metadata filters for StoredContentsExamples.

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

hasStoredContentsExampleFilter

boolean hasStoredContentsExampleFilter()

 The metadata filters for StoredContentsExamples.
 

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

Returns:

Whether the storedContentsExampleFilter field is set.

getStoredContentsExampleFilter

StoredContentsExampleFilter getStoredContentsExampleFilter()

 The metadata filters for StoredContentsExamples.
 

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

Returns:

The storedContentsExampleFilter.

getStoredContentsExampleFilterOrBuilder

StoredContentsExampleFilterOrBuilder getStoredContentsExampleFilterOrBuilder()

 The metadata filters for StoredContentsExamples.
 

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

getExampleStore

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:

The exampleStore.

getExampleStoreBytes

com.google.protobuf.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:

The bytes for exampleStore.

getPageSize

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:

The pageSize.

getPageToken

String getPageToken()

 Optional. The
 [next_page_token][google.cloud.aiplatform.v1beta1.FetchExamplesResponse.next_page_token]
 value returned from a previous list
 [ExampleStoreService.FetchExamplesResponse][] call.
 

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 Optional. The
 [next_page_token][google.cloud.aiplatform.v1beta1.FetchExamplesResponse.next_page_token]
 value returned from a previous list
 [ExampleStoreService.FetchExamplesResponse][] call.
 

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for pageToken.

getExampleIdsList

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:

A list containing the exampleIds.

getExampleIdsCount

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:

The count of exampleIds.

getExampleIds

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];

Parameters:

index - The index of the element to return.

Returns:

The exampleIds at the given index.

getExampleIdsBytes

com.google.protobuf.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];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the exampleIds at the given index.

getMetadataFilterCase

FetchExamplesRequest.MetadataFilterCase getMetadataFilterCase()