java.lang.Object
- software.amazon.awssdk.services.bedrockagentruntime.model.Collaborator

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Collaborator.Builder,Collaborator>

@Generated("software.amazon.awssdk:codegen")
public final class Collaborator
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Collaborator.Builder,Collaborator>

List of inline collaborators.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Collaborator.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<AgentActionGroup>`	`actionGroups()`	List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.
`AgentCollaboration`	`agentCollaboration()`	Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.
`String`	`agentCollaborationAsString()`	Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.
`String`	`agentName()`	Name of the inline collaborator agent which must be the same name as specified for `collaboratorName`.
`static Collaborator.Builder`	`builder()`
`List<CollaboratorConfiguration>`	`collaboratorConfigurations()`	Settings of the collaborator agent.
`String`	`customerEncryptionKeyArn()`	The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`foundationModel()`	The foundation model used by the inline collaborator agent.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`GuardrailConfigurationWithArn`	`guardrailConfiguration()`	Details of the guardwrail associated with the inline collaborator.
`boolean`	`hasActionGroups()`	For responses, this returns true if the service returned a value for the ActionGroups property.
`boolean`	`hasCollaboratorConfigurations()`	For responses, this returns true if the service returned a value for the CollaboratorConfigurations property.
`int`	`hashCode()`
`boolean`	`hasKnowledgeBases()`	For responses, this returns true if the service returned a value for the KnowledgeBases property.
`Integer`	`idleSessionTTLInSeconds()`	The number of seconds for which the Amazon Bedrock keeps information about the user's conversation with the inline collaborator agent.
`String`	`instruction()`	Instruction that tell the inline collaborator agent what it should do and how it should interact with users.
`List<KnowledgeBase>`	`knowledgeBases()`	Knowledge base associated with the inline collaborator agent.
`PromptOverrideConfiguration`	`promptOverrideConfiguration()`	Contains configurations to override prompt templates in different parts of an inline collaborator sequence.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Collaborator.Builder>`	`serializableBuilderClass()`
`Collaborator.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasActionGroups
```
public final boolean hasActionGroups()
```
    For responses, this returns true if the service returned a value for the ActionGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - actionGroups
```
public final List<AgentActionGroup> actionGroups()
```
    List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasActionGroups() method.
    
    Returns:
    
    List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.
  - agentCollaboration
```
public final AgentCollaboration agentCollaboration()
```
    Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.
    
    If the service returns an enum value that is not available in the current SDK version, agentCollaboration will return AgentCollaboration.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentCollaborationAsString().
    
    Returns:
    
    Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.
    
    See Also:
    
    AgentCollaboration
  - agentCollaborationAsString
```
public final String agentCollaborationAsString()
```
    Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.
    
    If the service returns an enum value that is not available in the current SDK version, agentCollaboration will return AgentCollaboration.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentCollaborationAsString().
    
    Returns:
    
    Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.
    
    See Also:
    
    AgentCollaboration
  - agentName
```
public final String agentName()
```
    Name of the inline collaborator agent which must be the same name as specified for collaboratorName.
    
    Returns:
    
    Name of the inline collaborator agent which must be the same name as specified for collaboratorName.
  - hasCollaboratorConfigurations
```
public final boolean hasCollaboratorConfigurations()
```
    For responses, this returns true if the service returned a value for the CollaboratorConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - collaboratorConfigurations
```
public final List<CollaboratorConfiguration> collaboratorConfigurations()
```
    Settings of the collaborator agent.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCollaboratorConfigurations() method.
    
    Returns:
    
    Settings of the collaborator agent.
  - customerEncryptionKeyArn
```
public final String customerEncryptionKeyArn()
```
    The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator.
  - foundationModel
```
public final String foundationModel()
```
    The foundation model used by the inline collaborator agent.
    
    Returns:
    
    The foundation model used by the inline collaborator agent.
  - guardrailConfiguration
```
public final GuardrailConfigurationWithArn guardrailConfiguration()
```
    Details of the guardwrail associated with the inline collaborator.
    
    Returns:
    
    Details of the guardwrail associated with the inline collaborator.
  - idleSessionTTLInSeconds
```
public final Integer idleSessionTTLInSeconds()
```
    The number of seconds for which the Amazon Bedrock keeps information about the user's conversation with the inline collaborator agent.
    
    A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
    
    Returns:
    
    The number of seconds for which the Amazon Bedrock keeps information about the user's conversation with the inline collaborator agent.
    
    A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
  - instruction
```
public final String instruction()
```
    Instruction that tell the inline collaborator agent what it should do and how it should interact with users.
    
    Returns:
    
    Instruction that tell the inline collaborator agent what it should do and how it should interact with users.
  - hasKnowledgeBases
```
public final boolean hasKnowledgeBases()
```
    For responses, this returns true if the service returned a value for the KnowledgeBases property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - knowledgeBases
```
public final List<KnowledgeBase> knowledgeBases()
```
    Knowledge base associated with the inline collaborator agent.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasKnowledgeBases() method.
    
    Returns:
    
    Knowledge base associated with the inline collaborator agent.
  - promptOverrideConfiguration
```
public final PromptOverrideConfiguration promptOverrideConfiguration()
```
    Contains configurations to override prompt templates in different parts of an inline collaborator sequence. For more information, see Advanced prompts.
    
    Returns:
    
    Contains configurations to override prompt templates in different parts of an inline collaborator sequence. For more information, see Advanced prompts.
  - toBuilder
```
public Collaborator.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Collaborator.Builder,Collaborator>
  - builder
```
public static Collaborator.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Collaborator.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class Collaborator

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasActionGroups

actionGroups

agentCollaboration

agentCollaborationAsString

agentName

hasCollaboratorConfigurations

collaboratorConfigurations

customerEncryptionKeyArn

foundationModel

guardrailConfiguration

idleSessionTTLInSeconds

instruction

hasKnowledgeBases

knowledgeBases

promptOverrideConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField