Interface Model.PageOptimizationConfig.PanelOrBuilder (2.5.1)

public static interface Model.PageOptimizationConfig.PanelOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCandidates(int index)

public abstract Model.PageOptimizationConfig.Candidate getCandidates(int index)

Required. The candidates to consider on the panel. Limit = 10.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
Model.PageOptimizationConfig.Candidate

getCandidatesCount()

public abstract int getCandidatesCount()

Required. The candidates to consider on the panel. Limit = 10.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

getCandidatesList()

public abstract List<Model.PageOptimizationConfig.Candidate> getCandidatesList()

Required. The candidates to consider on the panel. Limit = 10.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<Candidate>

getCandidatesOrBuilder(int index)

public abstract Model.PageOptimizationConfig.CandidateOrBuilder getCandidatesOrBuilder(int index)

Required. The candidates to consider on the panel. Limit = 10.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint
Returns
TypeDescription
Model.PageOptimizationConfig.CandidateOrBuilder

getCandidatesOrBuilderList()

public abstract List<? extends Model.PageOptimizationConfig.CandidateOrBuilder> getCandidatesOrBuilderList()

Required. The candidates to consider on the panel. Limit = 10.

repeated .google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate candidates = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<? extends com.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.CandidateOrBuilder>

getDefaultCandidate()

public abstract Model.PageOptimizationConfig.Candidate getDefaultCandidate()

Required. The default candidate (in case the model fails at serving time, we can fall back to the default).

.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate default_candidate = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Model.PageOptimizationConfig.Candidate

The defaultCandidate.

getDefaultCandidateOrBuilder()

public abstract Model.PageOptimizationConfig.CandidateOrBuilder getDefaultCandidateOrBuilder()

Required. The default candidate (in case the model fails at serving time, we can fall back to the default).

.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate default_candidate = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Model.PageOptimizationConfig.CandidateOrBuilder

getDisplayName()

public abstract String getDisplayName()

Optional. The name to display for the panel.

string display_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Optional. The name to display for the panel.

string display_name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for displayName.

hasDefaultCandidate()

public abstract boolean hasDefaultCandidate()

Required. The default candidate (in case the model fails at serving time, we can fall back to the default).

.google.cloud.retail.v2alpha.Model.PageOptimizationConfig.Candidate default_candidate = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the defaultCandidate field is set.