Class DownloadResult.Builder (2.34.0)

Version 2.34.0

• 2.44.1 (latest)
• 2.43.2
• 2.42.0
• 2.41.0
• 2.40.1
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.1
• 2.34.0
• 2.33.0
• 2.32.1
• 2.30.1
• 2.29.1
• 2.28.0
• 2.27.1
• 2.24.0
• 2.23.0
• 2.22.6
• 2.21.0
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.2
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.3
• 2.10.0
• 2.9.3
• 2.8.1
• 2.7.1
• 2.6.1
• 2.5.1
• 2.4.5
• 2.3.0
• 2.2.3
• 2.1.10

public static final class DownloadResult.Builder

Builds an instance of DownloadResult See Also: DownloadResult

Inheritance

java.lang.Object > DownloadResult.Builder

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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.