Class InputFile

java.lang.Object
software.amazon.awssdk.services.bedrockagentruntime.model.InputFile
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InputFile.Builder,InputFile>
@Generated("software.amazon.awssdk:codegen") public final class InputFile extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InputFile.Builder,InputFile>

Contains details of the source files.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the source file.

      Returns:
      The name of the source file.

    • source

      public final FileSource source()

      Specifies where the files are located.

      Returns:
      Specifies where the files are located.

    • useCase

      public final FileUseCase useCase()

      Specifies how the source files will be used by the code interpreter.

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

      Returns:
      Specifies how the source files will be used by the code interpreter.
      See Also:

    • useCaseAsString

      public final String useCaseAsString()

      Specifies how the source files will be used by the code interpreter.

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

      Returns:
      Specifies how the source files will be used by the code interpreter.
      See Also:

    • toBuilder

      public InputFile.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<InputFile.Builder,InputFile>
      Returns:
      a builder for type T

    • builder

      public static InputFile.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InputFile.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)
      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)

    • 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.