Class CreateAgentRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.quicksight.model.QuickSightRequest
software.amazon.awssdk.services.quicksight.model.CreateAgentRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateAgentRequest extends QuickSightRequest implements ToCopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>

  • Method Details

    • hasSpaces

      public final boolean hasSpaces()
      For responses, this returns true if the service returned a value for the Spaces 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.

    • spaces

      public final List<String> spaces()

      The Amazon Resource Names (ARNs) of the spaces to attach to the 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 hasSpaces() method.

      Returns:
      The Amazon Resource Names (ARNs) of the spaces to attach to the agent.

    • hasActionConnectors

      public final boolean hasActionConnectors()
      For responses, this returns true if the service returned a value for the ActionConnectors 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.

    • actionConnectors

      public final List<String> actionConnectors()

      The Amazon Resource Names (ARNs) of the action connectors to attach to the 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 hasActionConnectors() method.

      Returns:
      The Amazon Resource Names (ARNs) of the action connectors to attach to the agent.

    • awsAccountId

      public final String awsAccountId()

      The ID of the Amazon Web Services account that contains the agent.

      Returns:
      The ID of the Amazon Web Services account that contains the agent.

    • agentId

      public final String agentId()

      A unique identifier for the agent.

      Returns:
      A unique identifier for the agent.

    • name

      public final String name()

      The name of the agent.

      Returns:
      The name of the agent.

    • description

      public final String description()

      A description of the agent.

      Returns:
      A description of the agent.

    • iconId

      public final String iconId()

      The icon identifier for the agent.

      Returns:
      The icon identifier for the agent.

    • hasStarterPrompts

      public final boolean hasStarterPrompts()
      For responses, this returns true if the service returned a value for the StarterPrompts 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.

    • starterPrompts

      public final List<String> starterPrompts()

      A list of starter prompts that are displayed to users when they begin interacting with the 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 hasStarterPrompts() method.

      Returns:
      A list of starter prompts that are displayed to users when they begin interacting with the agent.

    • welcomeMessage

      public final String welcomeMessage()

      The welcome message that is displayed when a user starts a conversation with the agent.

      Returns:
      The welcome message that is displayed when a user starts a conversation with the agent.

    • agentLifecycle

      public final AgentLifecycle agentLifecycle()

      The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED.

      If the service returns an enum value that is not available in the current SDK version, agentLifecycle will return AgentLifecycle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentLifecycleAsString().

      Returns:
      The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED.
      See Also:

    • agentLifecycleAsString

      public final String agentLifecycleAsString()

      The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED.

      If the service returns an enum value that is not available in the current SDK version, agentLifecycle will return AgentLifecycle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentLifecycleAsString().

      Returns:
      The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED.
      See Also:

    • customPromptInput

      public final CustomPromptInput customPromptInput()

      The custom prompt configuration for the agent.

      Returns:
      The custom prompt configuration for the agent.

    • toBuilder

      public CreateAgentRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>
      Specified by:
      toBuilder in class QuickSightRequest
      Returns:
      a builder for type T

    • builder

      public static CreateAgentRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateAgentRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.