GenerateGroundedContentResponse.Candidate.Builder (proto-google-cloud-discoveryengine-v1beta 0.53.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.Builder>
    - - com.google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.Builder

All Implemented Interfaces:

GenerateGroundedContentResponse.CandidateOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

GenerateGroundedContentResponse.Candidate
```
public static final class GenerateGroundedContentResponse.Candidate.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.Builder>
implements GenerateGroundedContentResponse.CandidateOrBuilder
```
```
 A response candidate generated from the model.
 
```
Protobuf type google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GenerateGroundedContentResponse.Candidate.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`GenerateGroundedContentResponse.Candidate`	`build()`
`GenerateGroundedContentResponse.Candidate`	`buildPartial()`
`GenerateGroundedContentResponse.Candidate.Builder`	`clear()`
`GenerateGroundedContentResponse.Candidate.Builder`	`clearContent()` Content of the candidate.
`GenerateGroundedContentResponse.Candidate.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`GenerateGroundedContentResponse.Candidate.Builder`	`clearGroundingMetadata()` Grounding metadata for the generated content.
`GenerateGroundedContentResponse.Candidate.Builder`	`clearGroundingScore()` The overall grounding score for the candidate, in the range of [0, 1].
`GenerateGroundedContentResponse.Candidate.Builder`	`clearIndex()` Index of the candidate.
`GenerateGroundedContentResponse.Candidate.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`GenerateGroundedContentResponse.Candidate.Builder`	`clone()`
`GroundedGenerationContent`	`getContent()` Content of the candidate.
`GroundedGenerationContent.Builder`	`getContentBuilder()` Content of the candidate.
`GroundedGenerationContentOrBuilder`	`getContentOrBuilder()` Content of the candidate.
`GenerateGroundedContentResponse.Candidate`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`GenerateGroundedContentResponse.Candidate.GroundingMetadata`	`getGroundingMetadata()` Grounding metadata for the generated content.
`GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder`	`getGroundingMetadataBuilder()` Grounding metadata for the generated content.
`GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder`	`getGroundingMetadataOrBuilder()` Grounding metadata for the generated content.
`float`	`getGroundingScore()` The overall grounding score for the candidate, in the range of [0, 1].
`int`	`getIndex()` Index of the candidate.
`boolean`	`hasContent()` Content of the candidate.
`boolean`	`hasGroundingMetadata()` Grounding metadata for the generated content.
`boolean`	`hasGroundingScore()` The overall grounding score for the candidate, in the range of [0, 1].
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`GenerateGroundedContentResponse.Candidate.Builder`	`mergeContent(GroundedGenerationContent value)` Content of the candidate.
`GenerateGroundedContentResponse.Candidate.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`GenerateGroundedContentResponse.Candidate.Builder`	`mergeFrom(GenerateGroundedContentResponse.Candidate other)`
`GenerateGroundedContentResponse.Candidate.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`GenerateGroundedContentResponse.Candidate.Builder`	`mergeGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata value)` Grounding metadata for the generated content.
`GenerateGroundedContentResponse.Candidate.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`GenerateGroundedContentResponse.Candidate.Builder`	`setContent(GroundedGenerationContent.Builder builderForValue)` Content of the candidate.
`GenerateGroundedContentResponse.Candidate.Builder`	`setContent(GroundedGenerationContent value)` Content of the candidate.
`GenerateGroundedContentResponse.Candidate.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`GenerateGroundedContentResponse.Candidate.Builder`	`setGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder builderForValue)` Grounding metadata for the generated content.
`GenerateGroundedContentResponse.Candidate.Builder`	`setGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata value)` Grounding metadata for the generated content.
`GenerateGroundedContentResponse.Candidate.Builder`	`setGroundingScore(float value)` The overall grounding score for the candidate, in the range of [0, 1].
`GenerateGroundedContentResponse.Candidate.Builder`	`setIndex(int value)` Index of the candidate.
`GenerateGroundedContentResponse.Candidate.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`GenerateGroundedContentResponse.Candidate.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.Builder>
  - clear
```
public GenerateGroundedContentResponse.Candidate.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.Builder>
  - getDefaultInstanceForType
```
public GenerateGroundedContentResponse.Candidate getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public GenerateGroundedContentResponse.Candidate build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public GenerateGroundedContentResponse.Candidate buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public GenerateGroundedContentResponse.Candidate.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.Builder>
  - setField
```
public GenerateGroundedContentResponse.Candidate.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                  Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.Builder>
  - clearField
```
public GenerateGroundedContentResponse.Candidate.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.Builder>
  - clearOneof
```
public GenerateGroundedContentResponse.Candidate.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.Builder>
  - setRepeatedField
```
public GenerateGroundedContentResponse.Candidate.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                          int index,
                                                                          Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.Builder>
  - addRepeatedField
```
public GenerateGroundedContentResponse.Candidate.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                          Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.Builder>
  - mergeFrom
```
public GenerateGroundedContentResponse.Candidate.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateGroundedContentResponse.Candidate.Builder>
  - mergeFrom
```
public GenerateGroundedContentResponse.Candidate.Builder mergeFrom(GenerateGroundedContentResponse.Candidate other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.Builder>
  - mergeFrom
```
public GenerateGroundedContentResponse.Candidate.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateGroundedContentResponse.Candidate.Builder>
    
    Throws:
    
    IOException
  - getIndex
```
public int getIndex()
```
```
 Index of the candidate.
 
```
    int32 index = 1;
    Specified by:
    
    getIndex in interface GenerateGroundedContentResponse.CandidateOrBuilder
    
    Returns:
    
    The index.
  - setIndex
```
public GenerateGroundedContentResponse.Candidate.Builder setIndex(int value)
```
```
 Index of the candidate.
 
```
    int32 index = 1;
    Parameters:
    
    value - The index to set.
    
    Returns:
    
    This builder for chaining.
  - clearIndex
```
public GenerateGroundedContentResponse.Candidate.Builder clearIndex()
```
```
 Index of the candidate.
 
```
    int32 index = 1;
    Returns:
    
    This builder for chaining.
  - hasContent
```
public boolean hasContent()
```
```
 Content of the candidate.
 
```
    .google.cloud.discoveryengine.v1beta.GroundedGenerationContent content = 2;
    Specified by:
    
    hasContent in interface GenerateGroundedContentResponse.CandidateOrBuilder
    
    Returns:
    
    Whether the content field is set.
  - getContent
```
public GroundedGenerationContent getContent()
```
```
 Content of the candidate.
 
```
    .google.cloud.discoveryengine.v1beta.GroundedGenerationContent content = 2;
    Specified by:
    
    getContent in interface GenerateGroundedContentResponse.CandidateOrBuilder
    
    Returns:
    
    The content.
  - setContent
```
public GenerateGroundedContentResponse.Candidate.Builder setContent(GroundedGenerationContent value)
```
```
 Content of the candidate.
 
```
    .google.cloud.discoveryengine.v1beta.GroundedGenerationContent content = 2;
  - setContent
```
public GenerateGroundedContentResponse.Candidate.Builder setContent(GroundedGenerationContent.Builder builderForValue)
```
```
 Content of the candidate.
 
```
    .google.cloud.discoveryengine.v1beta.GroundedGenerationContent content = 2;
  - mergeContent
```
public GenerateGroundedContentResponse.Candidate.Builder mergeContent(GroundedGenerationContent value)
```
```
 Content of the candidate.
 
```
    .google.cloud.discoveryengine.v1beta.GroundedGenerationContent content = 2;
  - clearContent
```
public GenerateGroundedContentResponse.Candidate.Builder clearContent()
```
```
 Content of the candidate.
 
```
    .google.cloud.discoveryengine.v1beta.GroundedGenerationContent content = 2;
  - getContentBuilder
```
public GroundedGenerationContent.Builder getContentBuilder()
```
```
 Content of the candidate.
 
```
    .google.cloud.discoveryengine.v1beta.GroundedGenerationContent content = 2;
  - getContentOrBuilder
```
public GroundedGenerationContentOrBuilder getContentOrBuilder()
```
```
 Content of the candidate.
 
```
    .google.cloud.discoveryengine.v1beta.GroundedGenerationContent content = 2;
    Specified by:
    
    getContentOrBuilder in interface GenerateGroundedContentResponse.CandidateOrBuilder
  - hasGroundingScore
```
public boolean hasGroundingScore()
```
```
 The overall grounding score for the candidate, in the range of [0, 1].
 
```
    optional float grounding_score = 3;
    Specified by:
    
    hasGroundingScore in interface GenerateGroundedContentResponse.CandidateOrBuilder
    
    Returns:
    
    Whether the groundingScore field is set.
  - getGroundingScore
```
public float getGroundingScore()
```
```
 The overall grounding score for the candidate, in the range of [0, 1].
 
```
    optional float grounding_score = 3;
    Specified by:
    
    getGroundingScore in interface GenerateGroundedContentResponse.CandidateOrBuilder
    
    Returns:
    
    The groundingScore.
  - setGroundingScore
```
public GenerateGroundedContentResponse.Candidate.Builder setGroundingScore(float value)
```
```
 The overall grounding score for the candidate, in the range of [0, 1].
 
```
    optional float grounding_score = 3;
    Parameters:
    
    value - The groundingScore to set.
    
    Returns:
    
    This builder for chaining.
  - clearGroundingScore
```
public GenerateGroundedContentResponse.Candidate.Builder clearGroundingScore()
```
```
 The overall grounding score for the candidate, in the range of [0, 1].
 
```
    optional float grounding_score = 3;
    Returns:
    
    This builder for chaining.
  - hasGroundingMetadata
```
public boolean hasGroundingMetadata()
```
```
 Grounding metadata for the generated content.
 
```
    .google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;
    Specified by:
    
    hasGroundingMetadata in interface GenerateGroundedContentResponse.CandidateOrBuilder
    
    Returns:
    
    Whether the groundingMetadata field is set.
  - getGroundingMetadata
```
public GenerateGroundedContentResponse.Candidate.GroundingMetadata getGroundingMetadata()
```
```
 Grounding metadata for the generated content.
 
```
    .google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;
    Specified by:
    
    getGroundingMetadata in interface GenerateGroundedContentResponse.CandidateOrBuilder
    
    Returns:
    
    The groundingMetadata.
  - setGroundingMetadata
```
public GenerateGroundedContentResponse.Candidate.Builder setGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata value)
```
```
 Grounding metadata for the generated content.
 
```
    .google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;
  - setGroundingMetadata
```
public GenerateGroundedContentResponse.Candidate.Builder setGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder builderForValue)
```
```
 Grounding metadata for the generated content.
 
```
    .google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;
  - mergeGroundingMetadata
```
public GenerateGroundedContentResponse.Candidate.Builder mergeGroundingMetadata(GenerateGroundedContentResponse.Candidate.GroundingMetadata value)
```
```
 Grounding metadata for the generated content.
 
```
    .google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;
  - clearGroundingMetadata
```
public GenerateGroundedContentResponse.Candidate.Builder clearGroundingMetadata()
```
```
 Grounding metadata for the generated content.
 
```
    .google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;
  - getGroundingMetadataBuilder
```
public GenerateGroundedContentResponse.Candidate.GroundingMetadata.Builder getGroundingMetadataBuilder()
```
```
 Grounding metadata for the generated content.
 
```
    .google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;
  - getGroundingMetadataOrBuilder
```
public GenerateGroundedContentResponse.Candidate.GroundingMetadataOrBuilder getGroundingMetadataOrBuilder()
```
```
 Grounding metadata for the generated content.
 
```
    .google.cloud.discoveryengine.v1beta.GenerateGroundedContentResponse.Candidate.GroundingMetadata grounding_metadata = 4;
    Specified by:
    
    getGroundingMetadataOrBuilder in interface GenerateGroundedContentResponse.CandidateOrBuilder
  - setUnknownFields
```
public final GenerateGroundedContentResponse.Candidate.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.Builder>
  - mergeUnknownFields
```
public final GenerateGroundedContentResponse.Candidate.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentResponse.Candidate.Builder>

Class GenerateGroundedContentResponse.Candidate.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getIndex

setIndex

clearIndex

hasContent

getContent

setContent

setContent

mergeContent

clearContent

getContentBuilder

getContentOrBuilder

hasGroundingScore

getGroundingScore

setGroundingScore

clearGroundingScore

hasGroundingMetadata

getGroundingMetadata

setGroundingMetadata

setGroundingMetadata

mergeGroundingMetadata

clearGroundingMetadata

getGroundingMetadataBuilder

getGroundingMetadataOrBuilder

setUnknownFields

mergeUnknownFields