Package bg.codexio.ai.openai.api.payload.images.request

Record Class EditImageRequest

java.lang.Object
java.lang.Record
bg.codexio.ai.openai.api.payload.images.request.EditImageRequest
All Implemented Interfaces:
ImageRequest, Streamable
public record EditImageRequest(File image, String prompt, File mask, String model, Integer n, String size, String responseFormat, String user) extends Record implements ImageRequest

  • Constructor Summary

    Constructors
    Constructor
    Description
    EditImageRequest(File image, String prompt, File mask, String model, Integer n, String size, String responseFormat, String user)
    Creates an instance of a EditImageRequest record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    File
    image()
    Returns the value of the image record component.
    File
    mask()
    Returns the value of the mask record component.
    String
    model()
    Returns the value of the model record component.
    Integer
    n()
    Returns the value of the n record component.
    String
    prompt()
    Returns the value of the prompt record component.
    String
    responseFormat()
    Returns the value of the responseFormat record component.
    String
    size()
    Returns the value of the size record component.
    boolean
    stream()
     
    final String
    toString()
    Returns a string representation of this record class.
    String
    user()
    Returns the value of the user record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • EditImageRequest

      public EditImageRequest(File image, String prompt, File mask, String model, Integer n, String size, String responseFormat, String user)
      Creates an instance of a EditImageRequest record class.
      Parameters:
      image - the value for the image record component
      prompt - the value for the prompt record component
      mask - the value for the mask record component
      model - the value for the model record component
      n - the value for the n record component
      size - the value for the size record component
      responseFormat - the value for the responseFormat record component
      user - the value for the user record component

  • Method Details

    • stream

      public boolean stream()
      Specified by:
      stream in interface Streamable

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • image

      public File image()
      Returns the value of the image record component.
      Returns:
      the value of the image record component

    • prompt

      public String prompt()
      Returns the value of the prompt record component.
      Specified by:
      prompt in interface ImageRequest
      Returns:
      the value of the prompt record component

    • mask

      public File mask()
      Returns the value of the mask record component.
      Returns:
      the value of the mask record component

    • model

      public String model()
      Returns the value of the model record component.
      Specified by:
      model in interface ImageRequest
      Returns:
      the value of the model record component

    • n

      public Integer n()
      Returns the value of the n record component.
      Specified by:
      n in interface ImageRequest
      Returns:
      the value of the n record component

    • size

      public String size()
      Returns the value of the size record component.
      Specified by:
      size in interface ImageRequest
      Returns:
      the value of the size record component

    • responseFormat

      public String responseFormat()
      Returns the value of the responseFormat record component.
      Specified by:
      responseFormat in interface ImageRequest
      Returns:
      the value of the responseFormat record component

    • user

      public String user()
      Returns the value of the user record component.
      Specified by:
      user in interface ImageRequest
      Returns:
      the value of the user record component