Class Model.PageOptimizationConfig.Candidate (2.30.0)

public static final class Model.PageOptimizationConfig.Candidate extends GeneratedMessageV3 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Model.PageOptimizationConfig.Candidate

Static Fields

SERVING_CONFIG_ID_FIELD_NUMBER

public static final int SERVING_CONFIG_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Model.PageOptimizationConfig.Candidate getDefaultInstance()
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Model.PageOptimizationConfig.Candidate.Builder newBuilder()
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate.Builder

newBuilder(Model.PageOptimizationConfig.Candidate prototype)

public static Model.PageOptimizationConfig.Candidate.Builder newBuilder(Model.PageOptimizationConfig.Candidate prototype)
Parameter
NameDescription
prototypeModel.PageOptimizationConfig.Candidate
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate.Builder

parseDelimitedFrom(InputStream input)

public static Model.PageOptimizationConfig.Candidate parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Model.PageOptimizationConfig.Candidate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Model.PageOptimizationConfig.Candidate parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Model.PageOptimizationConfig.Candidate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Model.PageOptimizationConfig.Candidate parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Model.PageOptimizationConfig.Candidate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Model.PageOptimizationConfig.Candidate parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Model.PageOptimizationConfig.Candidate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Model.PageOptimizationConfig.Candidate parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Model.PageOptimizationConfig.Candidate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Model.PageOptimizationConfig.Candidate parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Model.PageOptimizationConfig.Candidate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Model.PageOptimizationConfig.Candidate> parser()
Returns
TypeDescription
Parser<Candidate>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCandidateCase()

public Model.PageOptimizationConfig.Candidate.CandidateCase getCandidateCase()
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate.CandidateCase

getDefaultInstanceForType()

public Model.PageOptimizationConfig.Candidate getDefaultInstanceForType()
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate

getParserForType()

public Parser<Model.PageOptimizationConfig.Candidate> getParserForType()
Returns
TypeDescription
Parser<Candidate>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getServingConfigId()

public String getServingConfigId()

This has to be a valid ServingConfig identifier. For example, 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
TypeDescription
String

The servingConfigId.

getServingConfigIdBytes()

public ByteString getServingConfigIdBytes()

This has to be a valid ServingConfig identifier. For example, 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
TypeDescription
ByteString

The bytes for servingConfigId.

hasServingConfigId()

public boolean hasServingConfigId()

This has to be a valid ServingConfig identifier. For example, 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
TypeDescription
boolean

Whether the servingConfigId field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Model.PageOptimizationConfig.Candidate.Builder newBuilderForType()
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Model.PageOptimizationConfig.Candidate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Model.PageOptimizationConfig.Candidate.Builder toBuilder()
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException