Class ActionGroupInvocationInput
- java.lang.Object
-
- software.amazon.awssdk.services.bedrockagentruntime.model.ActionGroupInvocationInput
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ActionGroupInvocationInput.Builder,ActionGroupInvocationInput>
@Generated("software.amazon.awssdk:codegen") public final class ActionGroupInvocationInput extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ActionGroupInvocationInput.Builder,ActionGroupInvocationInput>
Contains information about the action group being invoked. For more information about the possible structures, see the InvocationInput tab in OrchestrationTrace in the Amazon Bedrock User Guide.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceActionGroupInvocationInput.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringactionGroupName()The name of the action group.StringapiPath()The path to the API to call, based off the action group.static ActionGroupInvocationInput.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)Stringfunction()The function in the action group to call.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasParameters()For responses, this returns true if the service returned a value for the Parameters property.List<Parameter>parameters()The parameters in the Lambda input event.RequestBodyrequestBody()The parameters in the request body for the Lambda input event.List<SdkField<?>>sdkFields()static Class<? extends ActionGroupInvocationInput.Builder>serializableBuilderClass()ActionGroupInvocationInput.BuildertoBuilder()StringtoString()Returns a string representation of this object.Stringverb()The API method being used, based off the action group.-
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
-
actionGroupName
public final String actionGroupName()
The name of the action group.
- Returns:
- The name of the action group.
-
apiPath
public final String apiPath()
The path to the API to call, based off the action group.
- Returns:
- The path to the API to call, based off the action group.
-
function
public final String function()
The function in the action group to call.
- Returns:
- The function in the action group to call.
-
hasParameters
public final boolean hasParameters()
For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
parameters
public final List<Parameter> parameters()
The parameters in the Lambda input event.
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
hasParameters()method.- Returns:
- The parameters in the Lambda input event.
-
requestBody
public final RequestBody requestBody()
The parameters in the request body for the Lambda input event.
- Returns:
- The parameters in the request body for the Lambda input event.
-
verb
public final String verb()
The API method being used, based off the action group.
- Returns:
- The API method being used, based off the action group.
-
toBuilder
public ActionGroupInvocationInput.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ActionGroupInvocationInput.Builder,ActionGroupInvocationInput>
-
builder
public static ActionGroupInvocationInput.Builder builder()
-
serializableBuilderClass
public static Class<? extends ActionGroupInvocationInput.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-