com.google.cloud.discoveryengine.v1alpha

Class RankRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<RankRequest.Builder>

com.google.cloud.discoveryengine.v1alpha.RankRequest.Builder

All Implemented Interfaces:

RankRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

RankRequest

public static final class RankRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RankRequest.Builder>
implements RankRequestOrBuilder

 Request message for
 [RankService.Rank][google.cloud.discoveryengine.v1alpha.RankService.Rank]
 method.
 

Protobuf type google.cloud.discoveryengine.v1alpha.RankRequest

Method Summary

Modifier and Type	Method and Description
RankRequest.Builder	addAllRecords(Iterable<? extends RankingRecord> values) Required.
RankRequest.Builder	addRecords(int index, RankingRecord.Builder builderForValue) Required.
RankRequest.Builder	addRecords(int index, RankingRecord value) Required.
RankRequest.Builder	addRecords(RankingRecord.Builder builderForValue) Required.
RankRequest.Builder	addRecords(RankingRecord value) Required.
RankingRecord.Builder	addRecordsBuilder() Required.
RankingRecord.Builder	addRecordsBuilder(int index) Required.
RankRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RankRequest	build()
RankRequest	buildPartial()
RankRequest.Builder	clear()
RankRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
RankRequest.Builder	clearIgnoreRecordDetailsInResponse() If true, the response will contain only record ID and score.
RankRequest.Builder	clearModel() The identifier of the model to use.
RankRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
RankRequest.Builder	clearQuery() The query to use.
RankRequest.Builder	clearRankingConfig() Required.
RankRequest.Builder	clearRecords() Required.
RankRequest.Builder	clearTopN() The number of results to return.
RankRequest.Builder	clearUserLabels()
RankRequest.Builder	clone()
boolean	containsUserLabels(String key) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
RankRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getIgnoreRecordDetailsInResponse() If true, the response will contain only record ID and score.
String	getModel() The identifier of the model to use.
com.google.protobuf.ByteString	getModelBytes() The identifier of the model to use.
Map<String,String>	getMutableUserLabels() Deprecated.
String	getQuery() The query to use.
com.google.protobuf.ByteString	getQueryBytes() The query to use.
String	getRankingConfig() Required.
com.google.protobuf.ByteString	getRankingConfigBytes() Required.
RankingRecord	getRecords(int index) Required.
RankingRecord.Builder	getRecordsBuilder(int index) Required.
List<RankingRecord.Builder>	getRecordsBuilderList() Required.
int	getRecordsCount() Required.
List<RankingRecord>	getRecordsList() Required.
RankingRecordOrBuilder	getRecordsOrBuilder(int index) Required.
List<? extends RankingRecordOrBuilder>	getRecordsOrBuilderList() Required.
int	getTopN() The number of results to return.
Map<String,String>	getUserLabels() Deprecated.
int	getUserLabelsCount() The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
Map<String,String>	getUserLabelsMap() The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
String	getUserLabelsOrDefault(String key, String defaultValue) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
String	getUserLabelsOrThrow(String key) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMutableMapFieldReflection(int number)
boolean	isInitialized()
RankRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RankRequest.Builder	mergeFrom(com.google.protobuf.Message other)
RankRequest.Builder	mergeFrom(RankRequest other)
RankRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
RankRequest.Builder	putAllUserLabels(Map<String,String> values) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
RankRequest.Builder	putUserLabels(String key, String value) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
RankRequest.Builder	removeRecords(int index) Required.
RankRequest.Builder	removeUserLabels(String key) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
RankRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RankRequest.Builder	setIgnoreRecordDetailsInResponse(boolean value) If true, the response will contain only record ID and score.
RankRequest.Builder	setModel(String value) The identifier of the model to use.
RankRequest.Builder	setModelBytes(com.google.protobuf.ByteString value) The identifier of the model to use.
RankRequest.Builder	setQuery(String value) The query to use.
RankRequest.Builder	setQueryBytes(com.google.protobuf.ByteString value) The query to use.
RankRequest.Builder	setRankingConfig(String value) Required.
RankRequest.Builder	setRankingConfigBytes(com.google.protobuf.ByteString value) Required.
RankRequest.Builder	setRecords(int index, RankingRecord.Builder builderForValue) Required.
RankRequest.Builder	setRecords(int index, RankingRecord value) Required.
RankRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
RankRequest.Builder	setTopN(int value) The number of results to return.
RankRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<RankRequest.Builder>

internalGetMutableMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Overrides:

internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<RankRequest.Builder>

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RankRequest.Builder>

clear

public RankRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<RankRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RankRequest.Builder>

getDefaultInstanceForType

public RankRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public RankRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public RankRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public RankRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<RankRequest.Builder>

setField

public RankRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                    Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<RankRequest.Builder>

clearField

public RankRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RankRequest.Builder>

clearOneof

public RankRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RankRequest.Builder>

setRepeatedField

public RankRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            int index,
                                            Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RankRequest.Builder>

addRepeatedField

public RankRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RankRequest.Builder>

mergeFrom

public RankRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RankRequest.Builder>

mergeFrom

public RankRequest.Builder mergeFrom(RankRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RankRequest.Builder>

mergeFrom

public RankRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RankRequest.Builder>

Throws:

IOException

getRankingConfig

public String getRankingConfig()

 Required. The resource name of the rank service config, such as
 `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.
 

string ranking_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getRankingConfig in interface RankRequestOrBuilder

Returns:

The rankingConfig.

getRankingConfigBytes

public com.google.protobuf.ByteString getRankingConfigBytes()

 Required. The resource name of the rank service config, such as
 `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.
 

string ranking_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getRankingConfigBytes in interface RankRequestOrBuilder

Returns:

The bytes for rankingConfig.

setRankingConfig

public RankRequest.Builder setRankingConfig(String value)

 Required. The resource name of the rank service config, such as
 `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.
 

string ranking_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameters:

value - The rankingConfig to set.

Returns:

This builder for chaining.

clearRankingConfig

public RankRequest.Builder clearRankingConfig()

 Required. The resource name of the rank service config, such as
 `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.
 

string ranking_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

This builder for chaining.

setRankingConfigBytes

public RankRequest.Builder setRankingConfigBytes(com.google.protobuf.ByteString value)

 Required. The resource name of the rank service config, such as
 `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.
 

string ranking_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameters:

value - The bytes for rankingConfig to set.

Returns:

This builder for chaining.

getModel

public String getModel()

 The identifier of the model to use. It is one of:

 * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
 token size 512.

 It is set to `semantic-ranker-512@latest` by default if unspecified.
 

string model = 2;

Specified by:

getModel in interface RankRequestOrBuilder

Returns:

The model.

getModelBytes

public com.google.protobuf.ByteString getModelBytes()

 The identifier of the model to use. It is one of:

 * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
 token size 512.

 It is set to `semantic-ranker-512@latest` by default if unspecified.
 

string model = 2;

Specified by:

getModelBytes in interface RankRequestOrBuilder

Returns:

The bytes for model.

setModel

public RankRequest.Builder setModel(String value)

 The identifier of the model to use. It is one of:

 * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
 token size 512.

 It is set to `semantic-ranker-512@latest` by default if unspecified.
 

string model = 2;

Parameters:

value - The model to set.

Returns:

This builder for chaining.

clearModel

public RankRequest.Builder clearModel()

 The identifier of the model to use. It is one of:

 * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
 token size 512.

 It is set to `semantic-ranker-512@latest` by default if unspecified.
 

string model = 2;

Returns:

This builder for chaining.

setModelBytes

public RankRequest.Builder setModelBytes(com.google.protobuf.ByteString value)

 The identifier of the model to use. It is one of:

 * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
 token size 512.

 It is set to `semantic-ranker-512@latest` by default if unspecified.
 

string model = 2;

Parameters:

value - The bytes for model to set.

Returns:

This builder for chaining.

getTopN

public int getTopN()

 The number of results to return. If this is unset or no bigger than zero,
 returns all results.
 

int32 top_n = 3;

Specified by:

getTopN in interface RankRequestOrBuilder

Returns:

The topN.

setTopN

public RankRequest.Builder setTopN(int value)

 The number of results to return. If this is unset or no bigger than zero,
 returns all results.
 

int32 top_n = 3;

Parameters:

value - The topN to set.

Returns:

This builder for chaining.

clearTopN

public RankRequest.Builder clearTopN()

 The number of results to return. If this is unset or no bigger than zero,
 returns all results.
 

int32 top_n = 3;

Returns:

This builder for chaining.

getQuery

public String getQuery()

 The query to use.
 

string query = 4;

Specified by:

getQuery in interface RankRequestOrBuilder

Returns:

The query.

getQueryBytes

public com.google.protobuf.ByteString getQueryBytes()

 The query to use.
 

string query = 4;

Specified by:

getQueryBytes in interface RankRequestOrBuilder

Returns:

The bytes for query.

setQuery

public RankRequest.Builder setQuery(String value)

 The query to use.
 

string query = 4;

Parameters:

value - The query to set.

Returns:

This builder for chaining.

clearQuery

public RankRequest.Builder clearQuery()

 The query to use.
 

string query = 4;

Returns:

This builder for chaining.

setQueryBytes

public RankRequest.Builder setQueryBytes(com.google.protobuf.ByteString value)

 The query to use.
 

string query = 4;

Parameters:

value - The bytes for query to set.

Returns:

This builder for chaining.

getRecordsList

public List<RankingRecord> getRecordsList()

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getRecordsList in interface RankRequestOrBuilder

getRecordsCount

public int getRecordsCount()

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getRecordsCount in interface RankRequestOrBuilder

getRecords

public RankingRecord getRecords(int index)

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getRecords in interface RankRequestOrBuilder

setRecords

public RankRequest.Builder setRecords(int index,
                                      RankingRecord value)

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

setRecords

public RankRequest.Builder setRecords(int index,
                                      RankingRecord.Builder builderForValue)

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

addRecords

public RankRequest.Builder addRecords(RankingRecord value)

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

addRecords

public RankRequest.Builder addRecords(int index,
                                      RankingRecord value)

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

addRecords

public RankRequest.Builder addRecords(RankingRecord.Builder builderForValue)

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

addRecords

public RankRequest.Builder addRecords(int index,
                                      RankingRecord.Builder builderForValue)

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

addAllRecords

public RankRequest.Builder addAllRecords(Iterable<? extends RankingRecord> values)

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

clearRecords

public RankRequest.Builder clearRecords()

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

removeRecords

public RankRequest.Builder removeRecords(int index)

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

getRecordsBuilder

public RankingRecord.Builder getRecordsBuilder(int index)

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

getRecordsOrBuilder

public RankingRecordOrBuilder getRecordsOrBuilder(int index)

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getRecordsOrBuilder in interface RankRequestOrBuilder

getRecordsOrBuilderList

public List<? extends RankingRecordOrBuilder> getRecordsOrBuilderList()

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getRecordsOrBuilderList in interface RankRequestOrBuilder

addRecordsBuilder

public RankingRecord.Builder addRecordsBuilder()

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

addRecordsBuilder

public RankingRecord.Builder addRecordsBuilder(int index)

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

getRecordsBuilderList

public List<RankingRecord.Builder> getRecordsBuilderList()

 Required. A list of records to rank. At most 200 records to rank.
 

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5 [(.google.api.field_behavior) = REQUIRED];

getIgnoreRecordDetailsInResponse

public boolean getIgnoreRecordDetailsInResponse()

 If true, the response will contain only record ID and score. By default, it
 is false, the response will contain record details.
 

bool ignore_record_details_in_response = 6;

Specified by:

getIgnoreRecordDetailsInResponse in interface RankRequestOrBuilder

Returns:

The ignoreRecordDetailsInResponse.

setIgnoreRecordDetailsInResponse

public RankRequest.Builder setIgnoreRecordDetailsInResponse(boolean value)

 If true, the response will contain only record ID and score. By default, it
 is false, the response will contain record details.
 

bool ignore_record_details_in_response = 6;

Parameters:

value - The ignoreRecordDetailsInResponse to set.

Returns:

This builder for chaining.

clearIgnoreRecordDetailsInResponse

public RankRequest.Builder clearIgnoreRecordDetailsInResponse()

 If true, the response will contain only record ID and score. By default, it
 is false, the response will contain record details.
 

bool ignore_record_details_in_response = 6;

Returns:

This builder for chaining.

getUserLabelsCount

public int getUserLabelsCount()

Description copied from interface: RankRequestOrBuilder

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 7;

Specified by:

getUserLabelsCount in interface RankRequestOrBuilder

containsUserLabels

public boolean containsUserLabels(String key)

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 7;

Specified by:

containsUserLabels in interface RankRequestOrBuilder

getUserLabels

@Deprecated
public Map<String,String> getUserLabels()

Deprecated.

Use getUserLabelsMap() instead.

Specified by:

getUserLabels in interface RankRequestOrBuilder

getUserLabelsMap

public Map<String,String> getUserLabelsMap()

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 7;

Specified by:

getUserLabelsMap in interface RankRequestOrBuilder

getUserLabelsOrDefault

public String getUserLabelsOrDefault(String key,
                                     String defaultValue)

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 7;

Specified by:

getUserLabelsOrDefault in interface RankRequestOrBuilder

getUserLabelsOrThrow

public String getUserLabelsOrThrow(String key)

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 7;

Specified by:

getUserLabelsOrThrow in interface RankRequestOrBuilder

clearUserLabels

public RankRequest.Builder clearUserLabels()

removeUserLabels

public RankRequest.Builder removeUserLabels(String key)

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 7;

getMutableUserLabels

@Deprecated
public Map<String,String> getMutableUserLabels()

Deprecated.

Use alternate mutation accessors instead.

putUserLabels

public RankRequest.Builder putUserLabels(String key,
                                         String value)

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 7;

putAllUserLabels

public RankRequest.Builder putAllUserLabels(Map<String,String> values)

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 7;

setUnknownFields

public final RankRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RankRequest.Builder>

mergeUnknownFields

public final RankRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RankRequest.Builder>