Class FetchExamplesRequest (3.64.0)

public final class FetchExamplesRequest extends GeneratedMessageV3 implements FetchExamplesRequestOrBuilder

Request message for ExampleStoreService.FetchExamples.

Protobuf type google.cloud.aiplatform.v1beta1.FetchExamplesRequest

Static Fields

EXAMPLE_IDS_FIELD_NUMBER

public static final int EXAMPLE_IDS_FIELD_NUMBER
Field Value
Type Description
int

EXAMPLE_STORE_FIELD_NUMBER

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

getDefaultInstance()

public static FetchExamplesRequest getDefaultInstance()
Returns
Type Description
FetchExamplesRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static FetchExamplesRequest.Builder newBuilder()
Returns
Type Description
FetchExamplesRequest.Builder

newBuilder(FetchExamplesRequest prototype)

public static FetchExamplesRequest.Builder newBuilder(FetchExamplesRequest prototype)
Parameter
Name Description
prototype FetchExamplesRequest
Returns
Type Description
FetchExamplesRequest.Builder

parseDelimitedFrom(InputStream input)

public static FetchExamplesRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FetchExamplesRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FetchExamplesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FetchExamplesRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FetchExamplesRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FetchExamplesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FetchExamplesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FetchExamplesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FetchExamplesRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FetchExamplesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FetchExamplesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FetchExamplesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FetchExamplesRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FetchExamplesRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FetchExamplesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FetchExamplesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FetchExamplesRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FetchExamplesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FetchExamplesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FetchExamplesRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FetchExamplesRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FetchExamplesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FetchExamplesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FetchExamplesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FetchExamplesRequest> parser()
Returns
Type Description
Parser<FetchExamplesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public FetchExamplesRequest getDefaultInstanceForType()
Returns
Type Description
FetchExamplesRequest

getExampleIds(int index)

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.

getExampleIdsBytes(int 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.

getExampleIdsCount()

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.

getExampleIdsList()

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

Returns
Type Description
ProtocolStringList

A list containing the exampleIds.

getExampleStore()

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.

getExampleStoreBytes()

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.

getMetadataFilterCase()

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

getPageSize()

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

getParserForType()

public Parser<FetchExamplesRequest> getParserForType()
Returns
Type Description
Parser<FetchExamplesRequest>
Overrides

getSerializedSize()

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;

Returns
Type Description
StoredContentsExampleFilter

The storedContentsExampleFilter.

getStoredContentsExampleFilterOrBuilder()

public StoredContentsExampleFilterOrBuilder getStoredContentsExampleFilterOrBuilder()

The metadata filters for StoredContentsExamples.

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

Returns
Type Description
StoredContentsExampleFilterOrBuilder

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FetchExamplesRequest.Builder newBuilderForType()
Returns
Type Description
FetchExamplesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FetchExamplesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FetchExamplesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FetchExamplesRequest.Builder toBuilder()
Returns
Type Description
FetchExamplesRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException