Interface Model.PageOptimizationConfig.PanelOrBuilder (2.5.1)

Version 2.5.1

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

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

Name	Description
index	int

Returns

Type	Description
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

Type	Description
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

Type	Description
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

Name	Description
index	int

Returns

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
boolean	Whether the defaultCandidate field is set.