Package ai.extend.types

Class File.Builder

java.lang.Object

ai.extend.types.File.Builder

All Implemented Interfaces:

File._FinalStage, File.CreatedAtStage, File.IdStage, File.MetadataStage, File.NameStage, File.ObjectStage, File.UpdatedAtStage

Enclosing class:

File

public static final class File.Builder
extends java.lang.Object
implements File.ObjectStage, File.IdStage, File.NameStage, File.MetadataStage, File.CreatedAtStage, File.UpdatedAtStage, File._FinalStage

Method Summary

Modifier and Type	Method	Description
File	build()
File._FinalStage	contents(FileContents contents)
File._FinalStage	contents(java.util.Optional<FileContents> contents)
File.UpdatedAtStage	createdAt(java.time.OffsetDateTime createdAt)	The time (in UTC) at which the file was created.
File.Builder	from(File other)
File.NameStage	id(java.lang.String id)	Extend's internal ID for the file.
File.CreatedAtStage	metadata(FileMetadata metadata)
File.MetadataStage	name(java.lang.String name)	The name of the file
File.IdStage	object(java.lang.String object)	The type of response.
File._FinalStage	parentFileId(java.lang.String parentFileId)	The ID of the parent file.
File._FinalStage	parentFileId(java.util.Optional<java.lang.String> parentFileId)	The ID of the parent file.
File._FinalStage	presignedUrl(java.lang.String presignedUrl)	A presigned URL to download the file.
File._FinalStage	presignedUrl(java.util.Optional<java.lang.String> presignedUrl)	A presigned URL to download the file.
File._FinalStage	type(FileType type)	The type of the file
File._FinalStage	type(java.util.Optional<FileType> type)	The type of the file
File._FinalStage	updatedAt(java.time.OffsetDateTime updatedAt)	The time (in UTC) at which the file was last updated.
File._FinalStage	usage(FileCredits usage)
File._FinalStage	usage(java.util.Optional<FileCredits> usage)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public File.Builder from(File other)

Specified by:

from in interface File.ObjectStage

object

public File.IdStage object(@NotNull
                           java.lang.String object)

The type of response. In this case, it will always be "file".

The type of response. In this case, it will always be "file".

Specified by:

object in interface File.ObjectStage

Returns:

Reference to this so that method calls can be chained together.

id

public File.NameStage id(@NotNull
                         java.lang.String id)

Extend's internal ID for the file. It will always start with "file_".

Example: "file_xK9mLPqRtN3vS8wF5hB2cQ"

Extend's internal ID for the file. It will always start with "file_".

Example: "file_xK9mLPqRtN3vS8wF5hB2cQ"

Specified by:

id in interface File.IdStage

Returns:

Reference to this so that method calls can be chained together.

name

public File.MetadataStage name(@NotNull
                               java.lang.String name)

The name of the file

Example: "Invoices.pdf"

The name of the file

Example: "Invoices.pdf"

Specified by:

name in interface File.NameStage

Returns:

Reference to this so that method calls can be chained together.

metadata

public File.CreatedAtStage metadata(@NotNull
                                    FileMetadata metadata)

Specified by:

metadata in interface File.MetadataStage

createdAt

public File.UpdatedAtStage createdAt(@NotNull
                                     java.time.OffsetDateTime createdAt)

The time (in UTC) at which the file was created. Will follow the RFC 3339 format.

Example: "2024-03-21T15:30:00Z"

The time (in UTC) at which the file was created. Will follow the RFC 3339 format.

Example: "2024-03-21T15:30:00Z"

Specified by:

createdAt in interface File.CreatedAtStage

Returns:

Reference to this so that method calls can be chained together.

updatedAt

public File._FinalStage updatedAt(@NotNull
                                  java.time.OffsetDateTime updatedAt)

The time (in UTC) at which the file was last updated. Will follow the RFC 3339 format.

Example: "2024-03-21T16:45:00Z"

The time (in UTC) at which the file was last updated. Will follow the RFC 3339 format.

Example: "2024-03-21T16:45:00Z"

Specified by:

updatedAt in interface File.UpdatedAtStage

Returns:

Reference to this so that method calls can be chained together.

usage

public File._FinalStage usage(FileCredits usage)

Specified by:

usage in interface File._FinalStage

usage

public File._FinalStage usage(java.util.Optional<FileCredits> usage)

Specified by:

usage in interface File._FinalStage

contents

public File._FinalStage contents(FileContents contents)

Specified by:

contents in interface File._FinalStage

contents

public File._FinalStage contents(java.util.Optional<FileContents> contents)

Specified by:

contents in interface File._FinalStage

parentFileId

public File._FinalStage parentFileId(java.lang.String parentFileId)

The ID of the parent file. Only included if this file is a derivative of another file, for instance if it was created via a Splitter in a workflow.

Specified by:

parentFileId in interface File._FinalStage

Returns:

Reference to this so that method calls can be chained together.

parentFileId

public File._FinalStage parentFileId(java.util.Optional<java.lang.String> parentFileId)

The ID of the parent file. Only included if this file is a derivative of another file, for instance if it was created via a Splitter in a workflow.

Specified by:

parentFileId in interface File._FinalStage

presignedUrl

public File._FinalStage presignedUrl(java.lang.String presignedUrl)

A presigned URL to download the file. Expires after 15 minutes.

Specified by:

presignedUrl in interface File._FinalStage

Returns:

Reference to this so that method calls can be chained together.

presignedUrl

public File._FinalStage presignedUrl(java.util.Optional<java.lang.String> presignedUrl)

A presigned URL to download the file. Expires after 15 minutes.

Specified by:

presignedUrl in interface File._FinalStage

type

public File._FinalStage type(FileType type)

The type of the file

Specified by:

type in interface File._FinalStage

Returns:

Reference to this so that method calls can be chained together.

type

public File._FinalStage type(java.util.Optional<FileType> type)

The type of the file

Specified by:

type in interface File._FinalStage

build

public File build()

Specified by:

build in interface File._FinalStage