Class FetchExamplesRequest.Builder (3.64.0)

public static final class FetchExamplesRequest.Builder extends GeneratedMessageV3.Builder<FetchExamplesRequest.Builder> implements FetchExamplesRequestOrBuilder

Request message for ExampleStoreService.FetchExamples.

Protobuf type google.cloud.aiplatform.v1beta1.FetchExamplesRequest

Static Methods

getDescriptor()

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

Methods

addAllExampleIds(Iterable<String> values)

public FetchExamplesRequest.Builder addAllExampleIds(Iterable<String> values)

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
values Iterable<String>

The exampleIds to add.

Returns
Type Description
FetchExamplesRequest.Builder

This builder for chaining.

addExampleIds(String value)

public FetchExamplesRequest.Builder addExampleIds(String value)

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
value String

The exampleIds to add.

Returns
Type Description
FetchExamplesRequest.Builder

This builder for chaining.

addExampleIdsBytes(ByteString value)

public FetchExamplesRequest.Builder addExampleIdsBytes(ByteString value)

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
value ByteString

The bytes of the exampleIds to add.

Returns
Type Description
FetchExamplesRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FetchExamplesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FetchExamplesRequest.Builder
Overrides

build()

public FetchExamplesRequest build()
Returns
Type Description
FetchExamplesRequest

buildPartial()

public FetchExamplesRequest buildPartial()
Returns
Type Description
FetchExamplesRequest

clear()

public FetchExamplesRequest.Builder clear()
Returns
Type Description
FetchExamplesRequest.Builder
Overrides

clearExampleIds()

public FetchExamplesRequest.Builder clearExampleIds()

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
FetchExamplesRequest.Builder

This builder for chaining.

clearExampleStore()

public FetchExamplesRequest.Builder clearExampleStore()

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
FetchExamplesRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public FetchExamplesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
FetchExamplesRequest.Builder
Overrides

clearMetadataFilter()

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

clearOneof(Descriptors.OneofDescriptor oneof)

public FetchExamplesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
FetchExamplesRequest.Builder
Overrides

clearPageSize()

public FetchExamplesRequest.Builder clearPageSize()

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
FetchExamplesRequest.Builder

This builder for chaining.

clearPageToken()

public FetchExamplesRequest.Builder clearPageToken()

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
FetchExamplesRequest.Builder

This builder for chaining.

clearStoredContentsExampleFilter()

public FetchExamplesRequest.Builder clearStoredContentsExampleFilter()

The metadata filters for StoredContentsExamples.

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

Returns
Type Description
FetchExamplesRequest.Builder

clone()

public FetchExamplesRequest.Builder clone()
Returns
Type Description
FetchExamplesRequest.Builder
Overrides

getDefaultInstanceForType()

public FetchExamplesRequest getDefaultInstanceForType()
Returns
Type Description
FetchExamplesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

getStoredContentsExampleFilterBuilder()

public StoredContentsExampleFilter.Builder getStoredContentsExampleFilterBuilder()

The metadata filters for StoredContentsExamples.

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

Returns
Type Description
StoredContentsExampleFilter.Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(FetchExamplesRequest other)

public FetchExamplesRequest.Builder mergeFrom(FetchExamplesRequest other)
Parameter
Name Description
other FetchExamplesRequest
Returns
Type Description
FetchExamplesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FetchExamplesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FetchExamplesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public FetchExamplesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FetchExamplesRequest.Builder
Overrides

mergeStoredContentsExampleFilter(StoredContentsExampleFilter value)

public FetchExamplesRequest.Builder mergeStoredContentsExampleFilter(StoredContentsExampleFilter value)

The metadata filters for StoredContentsExamples.

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

Parameter
Name Description
value StoredContentsExampleFilter
Returns
Type Description
FetchExamplesRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FetchExamplesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FetchExamplesRequest.Builder
Overrides

setExampleIds(int index, String value)

public FetchExamplesRequest.Builder setExampleIds(int index, String value)

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
Name Description
index int

The index to set the value at.

value String

The exampleIds to set.

Returns
Type Description
FetchExamplesRequest.Builder

This builder for chaining.

setExampleStore(String value)

public FetchExamplesRequest.Builder setExampleStore(String value)

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) = { ... }

Parameter
Name Description
value String

The exampleStore to set.

Returns
Type Description
FetchExamplesRequest.Builder

This builder for chaining.

setExampleStoreBytes(ByteString value)

public FetchExamplesRequest.Builder setExampleStoreBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for exampleStore to set.

Returns
Type Description
FetchExamplesRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public FetchExamplesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FetchExamplesRequest.Builder
Overrides

setPageSize(int value)

public FetchExamplesRequest.Builder setPageSize(int value)

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
FetchExamplesRequest.Builder

This builder for chaining.

setPageToken(String value)

public FetchExamplesRequest.Builder setPageToken(String value)

Optional. The next_page_token value returned from a previous list [ExampleStoreService.FetchExamplesResponse][] call.

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
FetchExamplesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public FetchExamplesRequest.Builder setPageTokenBytes(ByteString value)

Optional. The next_page_token value returned from a previous list [ExampleStoreService.FetchExamplesResponse][] call.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
FetchExamplesRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public FetchExamplesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
FetchExamplesRequest.Builder
Overrides

setStoredContentsExampleFilter(StoredContentsExampleFilter value)

public FetchExamplesRequest.Builder setStoredContentsExampleFilter(StoredContentsExampleFilter value)

The metadata filters for StoredContentsExamples.

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

Parameter
Name Description
value StoredContentsExampleFilter
Returns
Type Description
FetchExamplesRequest.Builder

setStoredContentsExampleFilter(StoredContentsExampleFilter.Builder builderForValue)

public FetchExamplesRequest.Builder setStoredContentsExampleFilter(StoredContentsExampleFilter.Builder builderForValue)

The metadata filters for StoredContentsExamples.

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

Parameter
Name Description
builderForValue StoredContentsExampleFilter.Builder
Returns
Type Description
FetchExamplesRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final FetchExamplesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FetchExamplesRequest.Builder
Overrides