Class DownloadResult.Builder (2.38.0) 

public static final class DownloadResult.Builder

Builds an instance of DownloadResult See Also: DownloadResult

Inheritance

java.lang.Object > DownloadResult.Builder

Methods

build()

public DownloadResult build()

Creates a DownloadResult object.

Returns
Type Description
DownloadResult DownloadResult

setException(@NonNull Exception exception)

public DownloadResult.Builder setException(@NonNull Exception exception)

Sets the Exception produced by a failed download operation. This field will only be populated if the Transfer was not successful or skipped See Also: DownloadResult#getException()

Parameter
Name Description
exception @org.checkerframework.checker.nullness.qual.NonNull java.lang.Exception
Returns
Type Description
DownloadResult.Builder

the instance of the Builder with the value for exception modified.

setInput(@NonNull BlobInfo input)

public DownloadResult.Builder setInput(@NonNull BlobInfo input)

Sets the BlobInfo for the object request for download. This field is required. See Also: DownloadResult#getInput()

Parameter
Name Description
input @org.checkerframework.checker.nullness.qual.NonNull com.google.cloud.storage.BlobInfo
Returns
Type Description
DownloadResult.Builder

the instance of the Builder with the value for input modified.

setOutputDestination(@NonNull Path outputDestination)

public DownloadResult.Builder setOutputDestination(@NonNull Path outputDestination)

Sets the location on the Filesystem the object has been written to. This field will only be populated if the Transfer was successful. See Also: DownloadResult#getOutputDestination()

Parameter
Name Description
outputDestination @org.checkerframework.checker.nullness.qual.NonNull java.nio.file.Path
Returns
Type Description
DownloadResult.Builder

the instance of the Builder with the value for outputDestination modified.

setStatus(@NonNull TransferStatus status)

public DownloadResult.Builder setStatus(@NonNull TransferStatus status)

Sets the status of the download.This field is required. See Also: TransferStatus

Parameter
Name Description
status @org.checkerframework.checker.nullness.qual.NonNull com.google.cloud.storage.transfermanager.TransferStatus
Returns
Type Description
DownloadResult.Builder

the instance of the Builder with the value for status modified.