public static final class Model.PageOptimizationConfig.Candidate extends GeneratedMessage implements Model.PageOptimizationConfig.CandidateOrBuilderA 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 > GeneratedMessage > Model.PageOptimizationConfig.CandidateStatic Fields
SERVING_CONFIG_ID_FIELD_NUMBER
public static final int SERVING_CONFIG_ID_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static Model.PageOptimizationConfig.Candidate getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
Model.PageOptimizationConfig.Candidate |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static Model.PageOptimizationConfig.Candidate.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
Model.PageOptimizationConfig.Candidate.Builder |
|
newBuilder(Model.PageOptimizationConfig.Candidate prototype)
public static Model.PageOptimizationConfig.Candidate.Builder newBuilder(Model.PageOptimizationConfig.Candidate prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
Model.PageOptimizationConfig.Candidate |
| Returns | |
|---|---|
| Type | Description |
Model.PageOptimizationConfig.Candidate.Builder |
|
parseDelimitedFrom(InputStream input)
public static Model.PageOptimizationConfig.Candidate parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Model.PageOptimizationConfig.Candidate |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Model.PageOptimizationConfig.Candidate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Model.PageOptimizationConfig.Candidate |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static Model.PageOptimizationConfig.Candidate parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
Model.PageOptimizationConfig.Candidate |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Model.PageOptimizationConfig.Candidate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Model.PageOptimizationConfig.Candidate |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static Model.PageOptimizationConfig.Candidate parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
Model.PageOptimizationConfig.Candidate |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Model.PageOptimizationConfig.Candidate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Model.PageOptimizationConfig.Candidate |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static Model.PageOptimizationConfig.Candidate parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Model.PageOptimizationConfig.Candidate |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Model.PageOptimizationConfig.Candidate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Model.PageOptimizationConfig.Candidate |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static Model.PageOptimizationConfig.Candidate parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Model.PageOptimizationConfig.Candidate |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Model.PageOptimizationConfig.Candidate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Model.PageOptimizationConfig.Candidate |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static Model.PageOptimizationConfig.Candidate parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Model.PageOptimizationConfig.Candidate |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Model.PageOptimizationConfig.Candidate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Model.PageOptimizationConfig.Candidate |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<Model.PageOptimizationConfig.Candidate> parser()| Returns | |
|---|---|
| Type | Description |
Parser<Candidate> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
getParserForType()
public Parser<Model.PageOptimizationConfig.Candidate> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<Candidate> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean |
Whether the servingConfigId field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public Model.PageOptimizationConfig.Candidate.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
Model.PageOptimizationConfig.Candidate.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Model.PageOptimizationConfig.Candidate.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Model.PageOptimizationConfig.Candidate.Builder |
|
toBuilder()
public Model.PageOptimizationConfig.Candidate.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Model.PageOptimizationConfig.Candidate.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|