Class RetrieveMemoriesRequest.SimpleRetrievalParams.Builder (3.68.0)

public static final class RetrieveMemoriesRequest.SimpleRetrievalParams.Builder extends GeneratedMessageV3.Builder<RetrieveMemoriesRequest.SimpleRetrievalParams.Builder> implements RetrieveMemoriesRequest.SimpleRetrievalParamsOrBuilder

Parameters for simple (non-similarity search) retrieval.

Protobuf type google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimpleRetrievalParams

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public RetrieveMemoriesRequest.SimpleRetrievalParams build()
Returns
Type Description
RetrieveMemoriesRequest.SimpleRetrievalParams

buildPartial()

public RetrieveMemoriesRequest.SimpleRetrievalParams buildPartial()
Returns
Type Description
RetrieveMemoriesRequest.SimpleRetrievalParams

clear()

public RetrieveMemoriesRequest.SimpleRetrievalParams.Builder clear()
Returns
Type Description
RetrieveMemoriesRequest.SimpleRetrievalParams.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public RetrieveMemoriesRequest.SimpleRetrievalParams.Builder clearPageSize()

Optional. The maximum number of memories to return. The service may return fewer than this value. If unspecified, at most 3 memories will be returned. The maximum value is 100; values above 100 will be coerced to 100.

int32 page_size = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RetrieveMemoriesRequest.SimpleRetrievalParams.Builder

This builder for chaining.

clearPageToken()

public RetrieveMemoriesRequest.SimpleRetrievalParams.Builder clearPageToken()

Optional. A page token, received from a previous RetrieveMemories call. Provide this to retrieve the subsequent page.

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

Returns
Type Description
RetrieveMemoriesRequest.SimpleRetrievalParams.Builder

This builder for chaining.

clone()

public RetrieveMemoriesRequest.SimpleRetrievalParams.Builder clone()
Returns
Type Description
RetrieveMemoriesRequest.SimpleRetrievalParams.Builder
Overrides

getDefaultInstanceForType()

public RetrieveMemoriesRequest.SimpleRetrievalParams getDefaultInstanceForType()
Returns
Type Description
RetrieveMemoriesRequest.SimpleRetrievalParams

getDescriptorForType()

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

getPageSize()

public int getPageSize()

Optional. The maximum number of memories to return. The service may return fewer than this value. If unspecified, at most 3 memories will be returned. The maximum value is 100; values above 100 will be coerced to 100.

int32 page_size = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A page token, received from a previous RetrieveMemories call. Provide this to retrieve the subsequent page.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A page token, received from a previous RetrieveMemories call. Provide this to retrieve the subsequent page.

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

Returns
Type Description
ByteString

The bytes for pageToken.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RetrieveMemoriesRequest.SimpleRetrievalParams other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setPageSize(int value)

public RetrieveMemoriesRequest.SimpleRetrievalParams.Builder setPageSize(int value)

Optional. The maximum number of memories to return. The service may return fewer than this value. If unspecified, at most 3 memories will be returned. The maximum value is 100; values above 100 will be coerced to 100.

int32 page_size = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
RetrieveMemoriesRequest.SimpleRetrievalParams.Builder

This builder for chaining.

setPageToken(String value)

public RetrieveMemoriesRequest.SimpleRetrievalParams.Builder setPageToken(String value)

Optional. A page token, received from a previous RetrieveMemories call. Provide this to retrieve the subsequent page.

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
RetrieveMemoriesRequest.SimpleRetrievalParams.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public RetrieveMemoriesRequest.SimpleRetrievalParams.Builder setPageTokenBytes(ByteString value)

Optional. A page token, received from a previous RetrieveMemories call. Provide this to retrieve the subsequent page.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
RetrieveMemoriesRequest.SimpleRetrievalParams.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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