Package com.atlassian.bitbucket.filestore

Class GeneratePutUrlRequest.Builder

java.lang.Object

com.atlassian.bitbucket.util.BuilderSupport

com.atlassian.bitbucket.filestore.GeneratePutUrlRequest.Builder

Enclosing class:

GeneratePutUrlRequest

public static class GeneratePutUrlRequest.Builder
extends BuilderSupport

Field Summary

Fields inherited from class com.atlassian.bitbucket.util.BuilderSupport

NOT_BLANK

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GeneratePutUrlRequest	build()
GeneratePutUrlRequest.Builder	checksumSHA256(String value)	Instruct the service to use the given SHA256 checksum when generating the pre-authorized URL.
GeneratePutUrlRequest.Builder	expiry(Duration value)	The duration for which this pre-authorized request should be valid.
GeneratePutUrlRequest.Builder	namespace(String value)	The namespace of the file store to which the file will be uploaded to.
GeneratePutUrlRequest.Builder	path(FilePath value)	The path on the store to which the file will be uploaded to.

Methods inherited from class com.atlassian.bitbucket.util.BuilderSupport

addIf, addIf, addIf, addIf, addIf, addIf, checkNotBlank, requireNonBlank

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

build

public GeneratePutUrlRequest build()

checksumSHA256

@Nonnull
public GeneratePutUrlRequest.Builder checksumSHA256(@Nonnull
 String value)

Instruct the service to use the given SHA256 checksum when generating the pre-authorized URL. The uploaded object must match this checksum when the upload is complete, otherwise the upload will fail.

The string must be a base64 encoded SHA256 checksum.

This is an optional field.

expiry

@Nonnull
public GeneratePutUrlRequest.Builder expiry(@Nullable
 Duration value)

The duration for which this pre-authorized request should be valid. After this time has expired, attempting to use the URL will fail. This will be used in (for example) JWT authentication tokens or other schemes that involving pre-signing the URL such that the URL can only be used for a limited time.

This is an optional field.

namespace

@Nonnull
public GeneratePutUrlRequest.Builder namespace(@Nonnull
 String value)

The namespace of the file store to which the file will be uploaded to.

The namespace permits a given store to be partitioned into multiple logical stores, one per usage type.

This is a required field.

path

@Nonnull
public GeneratePutUrlRequest.Builder path(@Nonnull
 FilePath value)

The path on the store to which the file will be uploaded to.

This is a required field.