Class Model.PageOptimizationConfig.Candidate.Builder (2.4.0) 

public static final class Model.PageOptimizationConfig.Candidate.Builder extends GeneratedMessageV3.Builder<Model.PageOptimizationConfig.Candidate.Builder> implements Model.PageOptimizationConfig.CandidateOrBuilder

A candidate to consider for a given panel. Currently only ServingConfig are valid candidates.

Protobuf type google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Model.PageOptimizationConfig.Candidate.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Model.PageOptimizationConfig.Candidate build()
Returns
Type Description
Model.PageOptimizationConfig.Candidate

buildPartial()

public Model.PageOptimizationConfig.Candidate buildPartial()
Returns
Type Description
Model.PageOptimizationConfig.Candidate

clear()

public Model.PageOptimizationConfig.Candidate.Builder clear()
Returns
Type Description
Model.PageOptimizationConfig.Candidate.Builder
Overrides

clearCandidate()

public Model.PageOptimizationConfig.Candidate.Builder clearCandidate()
Returns
Type Description
Model.PageOptimizationConfig.Candidate.Builder

clearField(Descriptors.FieldDescriptor field)

public Model.PageOptimizationConfig.Candidate.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Model.PageOptimizationConfig.Candidate.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Model.PageOptimizationConfig.Candidate.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Model.PageOptimizationConfig.Candidate.Builder
Overrides

clearServingConfigId()

public Model.PageOptimizationConfig.Candidate.Builder clearServingConfigId()

This has to be a valid ServingConfig identifier. e.g. for a ServingConfig with full name: projects/*/locations/global/catalogs/default_catalog/servingConfigs/my_candidate_config this would be 'my_candidate_config'

string serving_config_id = 1;

Returns
Type Description
Model.PageOptimizationConfig.Candidate.Builder

This builder for chaining.

clone()

public Model.PageOptimizationConfig.Candidate.Builder clone()
Returns
Type Description
Model.PageOptimizationConfig.Candidate.Builder
Overrides

getCandidateCase()

public Model.PageOptimizationConfig.Candidate.CandidateCase getCandidateCase()
Returns
Type Description
Model.PageOptimizationConfig.Candidate.CandidateCase

getDefaultInstanceForType()

public Model.PageOptimizationConfig.Candidate getDefaultInstanceForType()
Returns
Type Description
Model.PageOptimizationConfig.Candidate

getDescriptorForType()

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

getServingConfigId()

public String getServingConfigId()

This has to be a valid ServingConfig identifier. e.g. for a ServingConfig with full name: projects/*/locations/global/catalogs/default_catalog/servingConfigs/my_candidate_config this would be 'my_candidate_config'

string serving_config_id = 1;

Returns
Type Description
String

The servingConfigId.

getServingConfigIdBytes()

public ByteString getServingConfigIdBytes()

This has to be a valid ServingConfig identifier. e.g. for a ServingConfig with full name: projects/*/locations/global/catalogs/default_catalog/servingConfigs/my_candidate_config this would be 'my_candidate_config'

string serving_config_id = 1;

Returns
Type Description
ByteString

The bytes for servingConfigId.

hasServingConfigId()

public boolean hasServingConfigId()

This has to be a valid ServingConfig identifier. e.g. for a ServingConfig with full name: projects/*/locations/global/catalogs/default_catalog/servingConfigs/my_candidate_config this would be 'my_candidate_config'

string serving_config_id = 1;

Returns
Type Description
boolean

Whether the servingConfigId field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Model.PageOptimizationConfig.Candidate other)

public Model.PageOptimizationConfig.Candidate.Builder mergeFrom(Model.PageOptimizationConfig.Candidate other)
Parameter
Name Description
other Model.PageOptimizationConfig.Candidate
Returns
Type Description
Model.PageOptimizationConfig.Candidate.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public Model.PageOptimizationConfig.Candidate.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Model.PageOptimizationConfig.Candidate.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Model.PageOptimizationConfig.Candidate.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Model.PageOptimizationConfig.Candidate.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setServingConfigId(String value)

public Model.PageOptimizationConfig.Candidate.Builder setServingConfigId(String value)

This has to be a valid ServingConfig identifier. e.g. for a ServingConfig with full name: projects/*/locations/global/catalogs/default_catalog/servingConfigs/my_candidate_config this would be 'my_candidate_config'

string serving_config_id = 1;

Parameter
Name Description
value String

The servingConfigId to set.
Returns
Type Description
Model.PageOptimizationConfig.Candidate.Builder

This builder for chaining.

setServingConfigIdBytes(ByteString value)

public Model.PageOptimizationConfig.Candidate.Builder setServingConfigIdBytes(ByteString value)

This has to be a valid ServingConfig identifier. e.g. for a ServingConfig with full name: projects/*/locations/global/catalogs/default_catalog/servingConfigs/my_candidate_config this would be 'my_candidate_config'

string serving_config_id = 1;

Parameter
Name Description
value ByteString

The bytes for servingConfigId to set.
Returns
Type Description
Model.PageOptimizationConfig.Candidate.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Model.PageOptimizationConfig.Candidate.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Model.PageOptimizationConfig.Candidate.Builder
Overrides