GenerateGroundedContentRequest (proto-google-cloud-discoveryengine-v1beta 0.53.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest

All Implemented Interfaces:

GenerateGroundedContentRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class GenerateGroundedContentRequest
extends com.google.protobuf.GeneratedMessageV3
implements GenerateGroundedContentRequestOrBuilder
```
```
 Top-level message sent by the client for the `GenerateGroundedContent`
 method.
 
```
Protobuf type google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GenerateGroundedContentRequest.Builder` Top-level message sent by the client for the `GenerateGroundedContent` method.
`static class`	`GenerateGroundedContentRequest.DynamicRetrievalConfiguration` Describes the options to customize dynamic retrieval.
`static interface`	`GenerateGroundedContentRequest.DynamicRetrievalConfigurationOrBuilder`
`static class`	`GenerateGroundedContentRequest.GenerationSpec` Content generation specification.
`static interface`	`GenerateGroundedContentRequest.GenerationSpecOrBuilder`
`static class`	`GenerateGroundedContentRequest.GroundingSource` Grounding source.
`static interface`	`GenerateGroundedContentRequest.GroundingSourceOrBuilder`
`static class`	`GenerateGroundedContentRequest.GroundingSpec` Grounding specification.
`static interface`	`GenerateGroundedContentRequest.GroundingSpecOrBuilder`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONTENTS_FIELD_NUMBER`
`static int`	`GENERATION_SPEC_FIELD_NUMBER`
`static int`	`GROUNDING_SPEC_FIELD_NUMBER`
`static int`	`LOCATION_FIELD_NUMBER`
`static int`	`SYSTEM_INSTRUCTION_FIELD_NUMBER`
`static int`	`USER_LABELS_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsUserLabels(String key)` The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
`boolean`	`equals(Object obj)`
`GroundedGenerationContent`	`getContents(int index)` Content of the current conversation with the model.
`int`	`getContentsCount()` Content of the current conversation with the model.
`List<GroundedGenerationContent>`	`getContentsList()` Content of the current conversation with the model.
`GroundedGenerationContentOrBuilder`	`getContentsOrBuilder(int index)` Content of the current conversation with the model.
`List<? extends GroundedGenerationContentOrBuilder>`	`getContentsOrBuilderList()` Content of the current conversation with the model.
`static GenerateGroundedContentRequest`	`getDefaultInstance()`
`GenerateGroundedContentRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`GenerateGroundedContentRequest.GenerationSpec`	`getGenerationSpec()` Content generation specification.
`GenerateGroundedContentRequest.GenerationSpecOrBuilder`	`getGenerationSpecOrBuilder()` Content generation specification.
`GenerateGroundedContentRequest.GroundingSpec`	`getGroundingSpec()` Grounding specification.
`GenerateGroundedContentRequest.GroundingSpecOrBuilder`	`getGroundingSpecOrBuilder()` Grounding specification.
`String`	`getLocation()` Required.
`com.google.protobuf.ByteString`	`getLocationBytes()` Required.
`com.google.protobuf.Parser<GenerateGroundedContentRequest>`	`getParserForType()`
`int`	`getSerializedSize()`
`GroundedGenerationContent`	`getSystemInstruction()` Content of the system instruction for the current API.
`GroundedGenerationContentOrBuilder`	`getSystemInstructionOrBuilder()` Content of the system instruction for the current API.
`Map<String,String>`	`getUserLabels()` Deprecated.
`int`	`getUserLabelsCount()` The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
`Map<String,String>`	`getUserLabelsMap()` The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
`String`	`getUserLabelsOrDefault(String key, String defaultValue)` The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
`String`	`getUserLabelsOrThrow(String key)` The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
`boolean`	`hasGenerationSpec()` Content generation specification.
`boolean`	`hasGroundingSpec()` Grounding specification.
`int`	`hashCode()`
`boolean`	`hasSystemInstruction()` Content of the system instruction for the current API.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`static GenerateGroundedContentRequest.Builder`	`newBuilder()`
`static GenerateGroundedContentRequest.Builder`	`newBuilder(GenerateGroundedContentRequest prototype)`
`GenerateGroundedContentRequest.Builder`	`newBuilderForType()`
`protected GenerateGroundedContentRequest.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static GenerateGroundedContentRequest`	`parseDelimitedFrom(InputStream input)`
`static GenerateGroundedContentRequest`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static GenerateGroundedContentRequest`	`parseFrom(byte[] data)`
`static GenerateGroundedContentRequest`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static GenerateGroundedContentRequest`	`parseFrom(ByteBuffer data)`
`static GenerateGroundedContentRequest`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static GenerateGroundedContentRequest`	`parseFrom(com.google.protobuf.ByteString data)`
`static GenerateGroundedContentRequest`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static GenerateGroundedContentRequest`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static GenerateGroundedContentRequest`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static GenerateGroundedContentRequest`	`parseFrom(InputStream input)`
`static GenerateGroundedContentRequest`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<GenerateGroundedContentRequest>`	`parser()`
`GenerateGroundedContentRequest.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

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

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

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- LOCATION_FIELD_NUMBER
```
public static final int LOCATION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SYSTEM_INSTRUCTION_FIELD_NUMBER
```
public static final int SYSTEM_INSTRUCTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CONTENTS_FIELD_NUMBER
```
public static final int CONTENTS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- GENERATION_SPEC_FIELD_NUMBER
```
public static final int GENERATION_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- GROUNDING_SPEC_FIELD_NUMBER
```
public static final int GROUNDING_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- USER_LABELS_FIELD_NUMBER
```
public static final int USER_LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
```
Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getLocation
```
public String getLocation()
```
```
 Required. Location resource.

 Format: `projects/{project}/locations/{location}`.
 
```
string location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Specified by:

getLocation in interface GenerateGroundedContentRequestOrBuilder

Returns:

The location.

getLocationBytes
```
public com.google.protobuf.ByteString getLocationBytes()
```
```
 Required. Location resource.

 Format: `projects/{project}/locations/{location}`.
 
```
string location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Specified by:

getLocationBytes in interface GenerateGroundedContentRequestOrBuilder

Returns:

The bytes for location.

hasSystemInstruction
```
public boolean hasSystemInstruction()
```
```
 Content of the system instruction for the current API.

 These instructions will take priority over any other prompt instructions
 if the selected model is supporting them.
 
```
.google.cloud.discoveryengine.v1beta.GroundedGenerationContent system_instruction = 5;
Specified by:

hasSystemInstruction in interface GenerateGroundedContentRequestOrBuilder

Returns:

Whether the systemInstruction field is set.

getSystemInstruction

public GroundedGenerationContent getSystemInstruction()

 Content of the system instruction for the current API.

 These instructions will take priority over any other prompt instructions
 if the selected model is supporting them.

.google.cloud.discoveryengine.v1beta.GroundedGenerationContent system_instruction = 5;

Specified by:: getSystemInstruction in interface GenerateGroundedContentRequestOrBuilder
Returns:: The systemInstruction.

getSystemInstructionOrBuilder

public GroundedGenerationContentOrBuilder getSystemInstructionOrBuilder()

 Content of the system instruction for the current API.

 These instructions will take priority over any other prompt instructions
 if the selected model is supporting them.

.google.cloud.discoveryengine.v1beta.GroundedGenerationContent system_instruction = 5;

Specified by:: getSystemInstructionOrBuilder in interface GenerateGroundedContentRequestOrBuilder

getContentsList

public List<GroundedGenerationContent> getContentsList()

 Content of the current conversation with the model.

 For single-turn queries, this is a single instance. For multi-turn queries,
 this is a repeated field that contains conversation history + latest
 request.

repeated .google.cloud.discoveryengine.v1beta.GroundedGenerationContent contents = 2;

Specified by:: getContentsList in interface GenerateGroundedContentRequestOrBuilder

getContentsOrBuilderList

public List<? extends GroundedGenerationContentOrBuilder> getContentsOrBuilderList()

 Content of the current conversation with the model.

 For single-turn queries, this is a single instance. For multi-turn queries,
 this is a repeated field that contains conversation history + latest
 request.

repeated .google.cloud.discoveryengine.v1beta.GroundedGenerationContent contents = 2;

Specified by:: getContentsOrBuilderList in interface GenerateGroundedContentRequestOrBuilder

getContentsCount

public int getContentsCount()

 Content of the current conversation with the model.

 For single-turn queries, this is a single instance. For multi-turn queries,
 this is a repeated field that contains conversation history + latest
 request.

repeated .google.cloud.discoveryengine.v1beta.GroundedGenerationContent contents = 2;

Specified by:: getContentsCount in interface GenerateGroundedContentRequestOrBuilder

getContents

public GroundedGenerationContent getContents(int index)

 Content of the current conversation with the model.

 For single-turn queries, this is a single instance. For multi-turn queries,
 this is a repeated field that contains conversation history + latest
 request.

repeated .google.cloud.discoveryengine.v1beta.GroundedGenerationContent contents = 2;

Specified by:: getContents in interface GenerateGroundedContentRequestOrBuilder

getContentsOrBuilder

public GroundedGenerationContentOrBuilder getContentsOrBuilder(int index)

 Content of the current conversation with the model.

 For single-turn queries, this is a single instance. For multi-turn queries,
 this is a repeated field that contains conversation history + latest
 request.

repeated .google.cloud.discoveryengine.v1beta.GroundedGenerationContent contents = 2;

Specified by:: getContentsOrBuilder in interface GenerateGroundedContentRequestOrBuilder

hasGenerationSpec
```
public boolean hasGenerationSpec()
```
```
 Content generation specification.
 
```
.google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GenerationSpec generation_spec = 3;
Specified by:

hasGenerationSpec in interface GenerateGroundedContentRequestOrBuilder

Returns:

Whether the generationSpec field is set.

getGenerationSpec
```
public GenerateGroundedContentRequest.GenerationSpec getGenerationSpec()
```
```
 Content generation specification.
 
```
.google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GenerationSpec generation_spec = 3;
Specified by:

getGenerationSpec in interface GenerateGroundedContentRequestOrBuilder

Returns:

The generationSpec.

getGenerationSpecOrBuilder
```
public GenerateGroundedContentRequest.GenerationSpecOrBuilder getGenerationSpecOrBuilder()
```
```
 Content generation specification.
 
```
.google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GenerationSpec generation_spec = 3;
Specified by:

getGenerationSpecOrBuilder in interface GenerateGroundedContentRequestOrBuilder

hasGroundingSpec
```
public boolean hasGroundingSpec()
```
```
 Grounding specification.
 
```
.google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GroundingSpec grounding_spec = 4;
Specified by:

hasGroundingSpec in interface GenerateGroundedContentRequestOrBuilder

Returns:

Whether the groundingSpec field is set.

getGroundingSpec
```
public GenerateGroundedContentRequest.GroundingSpec getGroundingSpec()
```
```
 Grounding specification.
 
```
.google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GroundingSpec grounding_spec = 4;
Specified by:

getGroundingSpec in interface GenerateGroundedContentRequestOrBuilder

Returns:

The groundingSpec.

getGroundingSpecOrBuilder
```
public GenerateGroundedContentRequest.GroundingSpecOrBuilder getGroundingSpecOrBuilder()
```
```
 Grounding specification.
 
```
.google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GroundingSpec grounding_spec = 4;
Specified by:

getGroundingSpecOrBuilder in interface GenerateGroundedContentRequestOrBuilder