Class PanelInfo.Builder (0.50.0)

public static final class PanelInfo.Builder extends GeneratedMessageV3.Builder<PanelInfo.Builder> implements PanelInfoOrBuilder

Detailed panel information associated with a user event.

Protobuf type google.cloud.discoveryengine.v1beta.PanelInfo

Implements

PanelInfoOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllDocuments(Iterable<? extends DocumentInfo> values)

public PanelInfo.Builder addAllDocuments(Iterable<? extends DocumentInfo> values)

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1beta.DocumentInfo>
Returns
Type Description
PanelInfo.Builder

addDocuments(DocumentInfo value)

public PanelInfo.Builder addDocuments(DocumentInfo value)

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value DocumentInfo
Returns
Type Description
PanelInfo.Builder

addDocuments(DocumentInfo.Builder builderForValue)

public PanelInfo.Builder addDocuments(DocumentInfo.Builder builderForValue)

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue DocumentInfo.Builder
Returns
Type Description
PanelInfo.Builder

addDocuments(int index, DocumentInfo value)

public PanelInfo.Builder addDocuments(int index, DocumentInfo value)

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value DocumentInfo
Returns
Type Description
PanelInfo.Builder

addDocuments(int index, DocumentInfo.Builder builderForValue)

public PanelInfo.Builder addDocuments(int index, DocumentInfo.Builder builderForValue)

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue DocumentInfo.Builder
Returns
Type Description
PanelInfo.Builder

addDocumentsBuilder()

public DocumentInfo.Builder addDocumentsBuilder()

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DocumentInfo.Builder

addDocumentsBuilder(int index)

public DocumentInfo.Builder addDocumentsBuilder(int index)

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DocumentInfo.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public PanelInfo build()
Returns
Type Description
PanelInfo

buildPartial()

public PanelInfo buildPartial()
Returns
Type Description
PanelInfo

clear()

public PanelInfo.Builder clear()
Returns
Type Description
PanelInfo.Builder
Overrides

clearDisplayName()

public PanelInfo.Builder clearDisplayName()

The display name of the panel.

string display_name = 3;

Returns
Type Description
PanelInfo.Builder

This builder for chaining.

clearDocuments()

public PanelInfo.Builder clearDocuments()

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PanelInfo.Builder

clearField(Descriptors.FieldDescriptor field)

public PanelInfo.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PanelInfo.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public PanelInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PanelInfo.Builder
Overrides

clearPanelId()

public PanelInfo.Builder clearPanelId()

Required. The panel ID.

string panel_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PanelInfo.Builder

This builder for chaining.

clearPanelPosition()

public PanelInfo.Builder clearPanelPosition()

The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set.

optional int32 panel_position = 4;

Returns
Type Description
PanelInfo.Builder

This builder for chaining.

clearTotalPanels()

public PanelInfo.Builder clearTotalPanels()

The total number of panels, including this one, shown to the user. Must be set if panel_position is set.

optional int32 total_panels = 5;

Returns
Type Description
PanelInfo.Builder

This builder for chaining.

clone()

public PanelInfo.Builder clone()
Returns
Type Description
PanelInfo.Builder
Overrides

getDefaultInstanceForType()

public PanelInfo getDefaultInstanceForType()
Returns
Type Description
PanelInfo

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

The display name of the panel.

string display_name = 3;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name of the panel.

string display_name = 3;

Returns
Type Description
ByteString

The bytes for displayName.

getDocuments(int index)

public DocumentInfo getDocuments(int index)

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DocumentInfo

getDocumentsBuilder(int index)

public DocumentInfo.Builder getDocumentsBuilder(int index)

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DocumentInfo.Builder

getDocumentsBuilderList()

public List<DocumentInfo.Builder> getDocumentsBuilderList()

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getDocumentsCount()

public int getDocumentsCount()

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getDocumentsList()

public List<DocumentInfo> getDocumentsList()

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<DocumentInfo>

getDocumentsOrBuilder(int index)

public DocumentInfoOrBuilder getDocumentsOrBuilder(int index)

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
DocumentInfoOrBuilder

getDocumentsOrBuilderList()

public List<? extends DocumentInfoOrBuilder> getDocumentsOrBuilderList()

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1beta.DocumentInfoOrBuilder>

getPanelId()

public String getPanelId()

Required. The panel ID.

string panel_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The panelId.

getPanelIdBytes()

public ByteString getPanelIdBytes()

Required. The panel ID.

string panel_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for panelId.

getPanelPosition()

public int getPanelPosition()

The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set.

optional int32 panel_position = 4;

Returns
Type Description
int

The panelPosition.

getTotalPanels()

public int getTotalPanels()

The total number of panels, including this one, shown to the user. Must be set if panel_position is set.

optional int32 total_panels = 5;

Returns
Type Description
int

The totalPanels.

hasPanelPosition()

public boolean hasPanelPosition()

The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set.

optional int32 panel_position = 4;

Returns
Type Description
boolean

Whether the panelPosition field is set.

hasTotalPanels()

public boolean hasTotalPanels()

The total number of panels, including this one, shown to the user. Must be set if panel_position is set.

optional int32 total_panels = 5;

Returns
Type Description
boolean

Whether the totalPanels field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PanelInfo other)

public PanelInfo.Builder mergeFrom(PanelInfo other)
Parameter
Name Description
other PanelInfo
Returns
Type Description
PanelInfo.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public PanelInfo.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PanelInfo.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PanelInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PanelInfo.Builder
Overrides

removeDocuments(int index)

public PanelInfo.Builder removeDocuments(int index)

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
PanelInfo.Builder

setDisplayName(String value)

public PanelInfo.Builder setDisplayName(String value)

The display name of the panel.

string display_name = 3;

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
PanelInfo.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public PanelInfo.Builder setDisplayNameBytes(ByteString value)

The display name of the panel.

string display_name = 3;

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
PanelInfo.Builder

This builder for chaining.

setDocuments(int index, DocumentInfo value)

public PanelInfo.Builder setDocuments(int index, DocumentInfo value)

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value DocumentInfo
Returns
Type Description
PanelInfo.Builder

setDocuments(int index, DocumentInfo.Builder builderForValue)

public PanelInfo.Builder setDocuments(int index, DocumentInfo.Builder builderForValue)

Optional. The document IDs associated with this panel.

repeated .google.cloud.discoveryengine.v1beta.DocumentInfo documents = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue DocumentInfo.Builder
Returns
Type Description
PanelInfo.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setPanelId(String value)

public PanelInfo.Builder setPanelId(String value)

Required. The panel ID.

string panel_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The panelId to set.

Returns
Type Description
PanelInfo.Builder

This builder for chaining.

setPanelIdBytes(ByteString value)

public PanelInfo.Builder setPanelIdBytes(ByteString value)

Required. The panel ID.

string panel_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for panelId to set.

Returns
Type Description
PanelInfo.Builder

This builder for chaining.

setPanelPosition(int value)

public PanelInfo.Builder setPanelPosition(int value)

The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set.

optional int32 panel_position = 4;

Parameter
Name Description
value int

The panelPosition to set.

Returns
Type Description
PanelInfo.Builder

This builder for chaining.

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

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

setTotalPanels(int value)

public PanelInfo.Builder setTotalPanels(int value)

The total number of panels, including this one, shown to the user. Must be set if panel_position is set.

optional int32 total_panels = 5;

Parameter
Name Description
value int

The totalPanels to set.

Returns
Type Description
PanelInfo.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final PanelInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PanelInfo.Builder
Overrides