Package software.amazon.awssdk.services.bedrockagent.model

Class CreateFlowRequest

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

  • Method Details

    • name

      public final String name()

      A name for the flow.

      Returns:
      A name for the flow.

    • description

      public final String description()

      A description for the flow.

      Returns:
      A description for the flow.

    • executionRoleArn

      public final String executionRoleArn()

      The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.

      Returns:
      The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.

    • customerEncryptionKeyArn

      public final String customerEncryptionKeyArn()

      The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.

      Returns:
      The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.

    • definition

      public final FlowDefinition definition()

      A definition of the nodes and connections between nodes in the flow.

      Returns:
      A definition of the nodes and connections between nodes in the flow.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

      Returns:
      A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      Any tags that you want to attach to the flow. For more information, see Tagging resources in Amazon Bedrock.

      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 hasTags() method.

      Returns:
      Any tags that you want to attach to the flow. For more information, see Tagging resources in Amazon Bedrock.

    • toBuilder

      public CreateFlowRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateFlowRequest.Builder,CreateFlowRequest>
      Specified by:
      toBuilder in class BedrockAgentRequest

    • builder

      public static CreateFlowRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateFlowRequest.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)
      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)
      Overrides:
      getValueForField in class SdkRequest

    • 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