Class ParallelUploadConfig.Builder (2.58.1)

public static final class ParallelUploadConfig.Builder

Builds an instance of ParallelUploadConfig. See Also: ParallelUploadConfig

Inheritance

java.lang.Object > ParallelUploadConfig.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 ParallelUploadConfig build()

Creates a ParallelUploadConfig object.

Returns
Type	Description
`ParallelUploadConfig`	ParallelUploadConfig

setBucketName(@NonNull String bucketName)

public ParallelUploadConfig.Builder setBucketName(@NonNull String bucketName)

Sets the bucketName that Transfer Manager will upload to. This field is required. See Also: ParallelUploadConfig#getBucketName()

Parameter
Name	Description
`bucketName`	`@org.checkerframework.checker.nullness.qual.NonNull java.lang.String`

Returns
Type	Description
`ParallelUploadConfig.Builder`	the builder instance with the value for bucketName modified.

setPrefix(@NonNull String prefix)

public ParallelUploadConfig.Builder setPrefix(@NonNull String prefix)

Sets a common prefix that will be applied to all object paths in the destination bucket.

NOTE: this method and #setUploadBlobInfoFactory(UploadBlobInfoFactory) are mutually exclusive, and last invocation "wins". See Also: ParallelUploadConfig#getPrefix(), ParallelUploadConfig.Builder#setUploadBlobInfoFactory(UploadBlobInfoFactory), UploadBlobInfoFactory#prefixObjectNames(String)

Parameter
Name	Description
`prefix`	`@org.checkerframework.checker.nullness.qual.NonNull java.lang.String`

Returns
Type	Description
`ParallelUploadConfig.Builder`	the builder instance with the value for prefix modified.

setSkipIfExists(boolean skipIfExists)

public ParallelUploadConfig.Builder setSkipIfExists(boolean skipIfExists)

Sets the parameter for skipIfExists. When set to true Transfer Manager will skip uploading an object if it already exists. See Also: ParallelUploadConfig#isSkipIfExists()

Parameter
Name	Description
`skipIfExists`	`boolean`

Returns
Type	Description
`ParallelUploadConfig.Builder`	the builder instance with the value for skipIfExists modified.

setUploadBlobInfoFactory(@NonNull ParallelUploadConfig.UploadBlobInfoFactory uploadBlobInfoFactory)

public ParallelUploadConfig.Builder setUploadBlobInfoFactory(@NonNull ParallelUploadConfig.UploadBlobInfoFactory uploadBlobInfoFactory)

Sets a UploadBlobInfoFactory which can be used to produce a custom BlobInfo based on a provided bucket name and file name.

The bucket name in the returned BlobInfo MUST be equal to the value provided to #setBucketName(String), if not that upload will fail with a TransferStatus#FAILED_TO_START and a BucketNameMismatchException.

NOTE: this method and #setPrefix(String) are mutually exclusive, and last invocation "wins". See Also: ParallelUploadConfig#getPrefix(), ParallelUploadConfig#getUploadBlobInfoFactory()

Parameter
Name	Description
`uploadBlobInfoFactory`	`@org.checkerframework.checker.nullness.qual.NonNull com.google.cloud.storage.transfermanager.ParallelUploadConfig.UploadBlobInfoFactory`

Returns
Type	Description
`ParallelUploadConfig.Builder`	the builder instance with the value for uploadBlobInfoFactory modified.

setWriteOptsPerRequest(@NonNull List<Storage.BlobWriteOption> writeOptsPerRequest)

public ParallelUploadConfig.Builder setWriteOptsPerRequest(@NonNull List<Storage.BlobWriteOption> writeOptsPerRequest)

Sets the BlobWriteOptions that will be applied to each upload request. Note these options will be applied to every single upload request. See Also: ParallelUploadConfig#getWriteOptsPerRequest()

Parameter
Name	Description
`writeOptsPerRequest`	`@org.checkerframework.checker.nullness.qual.NonNull java.util.List<BlobWriteOption>`

Returns
Type	Description
`ParallelUploadConfig.Builder`	the builder instance with the value for WriteOptsPerRequest modified.