Class GroundingAttribution (1.5.0)

public final class GroundingAttribution extends GeneratedMessageV3 implements GroundingAttributionOrBuilder

Grounding attribution.

Protobuf type google.cloud.vertexai.v1.GroundingAttribution

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > GroundingAttribution

Implements

GroundingAttributionOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CONFIDENCE_SCORE_FIELD_NUMBER

public static final int CONFIDENCE_SCORE_FIELD_NUMBER

Field Value
Type	Description
int

SEGMENT_FIELD_NUMBER

public static final int SEGMENT_FIELD_NUMBER

Field Value
Type	Description
int

WEB_FIELD_NUMBER

public static final int WEB_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static GroundingAttribution getDefaultInstance()

Returns
Type	Description
GroundingAttribution

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static GroundingAttribution.Builder newBuilder()

Returns
Type	Description
GroundingAttribution.Builder

newBuilder(GroundingAttribution prototype)

public static GroundingAttribution.Builder newBuilder(GroundingAttribution prototype)

Parameter
Name	Description
prototype	GroundingAttribution

Returns
Type	Description
GroundingAttribution.Builder

parseDelimitedFrom(InputStream input)

public static GroundingAttribution parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
GroundingAttribution

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GroundingAttribution parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GroundingAttribution

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static GroundingAttribution parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
GroundingAttribution

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GroundingAttribution parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GroundingAttribution

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GroundingAttribution parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
GroundingAttribution

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GroundingAttribution parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GroundingAttribution

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GroundingAttribution parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
GroundingAttribution

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GroundingAttribution parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GroundingAttribution

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static GroundingAttribution parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
GroundingAttribution

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GroundingAttribution parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GroundingAttribution

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static GroundingAttribution parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
GroundingAttribution

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GroundingAttribution parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GroundingAttribution

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<GroundingAttribution> parser()

Returns
Type	Description
Parser<GroundingAttribution>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getConfidenceScore()

public float getConfidenceScore()

Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident.

optional float confidence_score = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
float	The confidenceScore.

getDefaultInstanceForType()

public GroundingAttribution getDefaultInstanceForType()

Returns
Type	Description
GroundingAttribution

getParserForType()

public Parser<GroundingAttribution> getParserForType()

Returns
Type	Description
Parser<GroundingAttribution>

Overrides

GeneratedMessageV3.getParserForType()

getReferenceCase()

public GroundingAttribution.ReferenceCase getReferenceCase()

Returns
Type	Description
GroundingAttribution.ReferenceCase

getSegment()

public Segment getSegment()

Output only. Segment of the content this attribution belongs to.

.google.cloud.vertexai.v1.Segment segment = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Segment	The segment.

getSegmentOrBuilder()

public SegmentOrBuilder getSegmentOrBuilder()

Output only. Segment of the content this attribution belongs to.

.google.cloud.vertexai.v1.Segment segment = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SegmentOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getWeb()

public GroundingAttribution.Web getWeb()

Optional. Attribution from the web.

.google.cloud.vertexai.v1.GroundingAttribution.Web web = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
GroundingAttribution.Web	The web.

getWebOrBuilder()

public GroundingAttribution.WebOrBuilder getWebOrBuilder()

Optional. Attribution from the web.

.google.cloud.vertexai.v1.GroundingAttribution.Web web = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
GroundingAttribution.WebOrBuilder

hasConfidenceScore()

public boolean hasConfidenceScore()

Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident.

optional float confidence_score = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the confidenceScore field is set.

hasSegment()

public boolean hasSegment()

Output only. Segment of the content this attribution belongs to.

.google.cloud.vertexai.v1.Segment segment = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the segment field is set.

hasWeb()

public boolean hasWeb()

Optional. Attribution from the web.

.google.cloud.vertexai.v1.GroundingAttribution.Web web = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the web field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public GroundingAttribution.Builder newBuilderForType()

Returns
Type	Description
GroundingAttribution.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GroundingAttribution.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
GroundingAttribution.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public GroundingAttribution.Builder toBuilder()

Returns
Type	Description
GroundingAttribution.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException