Class Storage.CopyRequest (2.37.0)

public static class Storage.CopyRequest implements Serializable

A class to contain all information needed for a Google Cloud Storage Copy operation.

Inheritance

java.lang.Object > Storage.CopyRequest

Implements

Serializable

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)

Static Methods

newBuilder()

public static Storage.CopyRequest.Builder newBuilder()

Creates a builder for CopyRequest objects.

Returns
Type	Description
`Storage.CopyRequest.Builder`

of(BlobId sourceBlobId, BlobId targetBlobId)

public static Storage.CopyRequest of(BlobId sourceBlobId, BlobId targetBlobId)

Creates a copy request. Target blob information is copied from source.

Parameters
Name	Description
`sourceBlobId`	`BlobId` a `BlobId` object for the source blob
`targetBlobId`	`BlobId` a `BlobId` object for the target blob

Returns
Type	Description
`Storage.CopyRequest`	a copy request

of(BlobId sourceBlobId, BlobInfo target)

public static Storage.CopyRequest of(BlobId sourceBlobId, BlobInfo target)

Creates a copy request. target parameter is used to replace source blob information (e.g. contentType, contentLanguage). Target blob information is set exactly to target, no information is inherited from the source blob.

Parameters
Name	Description
`sourceBlobId`	`BlobId` a `BlobId` object for the source blob
`target`	`BlobInfo` a `BlobInfo` object for the target blob

Returns
Type	Description
`Storage.CopyRequest`	a copy request

of(BlobId sourceBlobId, String targetBlob)

public static Storage.CopyRequest of(BlobId sourceBlobId, String targetBlob)

Creates a copy request. Target blob information is copied from source.

Parameters
Name	Description
`sourceBlobId`	`BlobId` a `BlobId` object for the source blob
`targetBlob`	`String` name of the target blob, in the same bucket of the source blob

Returns
Type	Description
`Storage.CopyRequest`	a copy request

of(String sourceBucket, String sourceBlob, BlobId target)

public static Storage.CopyRequest of(String sourceBucket, String sourceBlob, BlobId target)

Creates a copy request. Target blob information is copied from source.

Parameters
Name	Description
`sourceBucket`	`String` name of the bucket containing the source blob
`sourceBlob`	`String` name of the source blob
`target`	`BlobId` a `BlobId` object for the target blob

Returns
Type	Description
`Storage.CopyRequest`	a copy request

of(String sourceBucket, String sourceBlob, BlobInfo target)

public static Storage.CopyRequest of(String sourceBucket, String sourceBlob, BlobInfo target)

Creates a copy request. target parameter is used to override source blob information (e.g. contentType, contentLanguage).

Parameters
Name	Description
`sourceBucket`	`String` name of the bucket containing the source blob
`sourceBlob`	`String` name of the source blob
`target`	`BlobInfo` a `BlobInfo` object for the target blob

Returns
Type	Description
`Storage.CopyRequest`	a copy request

of(String sourceBucket, String sourceBlob, String targetBlob)

public static Storage.CopyRequest of(String sourceBucket, String sourceBlob, String targetBlob)

Creates a copy request. Target blob information is copied from source.

Parameters
Name	Description
`sourceBucket`	`String` name of the bucket containing both the source and the target blob
`sourceBlob`	`String` name of the source blob
`targetBlob`	`String` name of the target blob

Returns
Type	Description
`Storage.CopyRequest`	a copy request

Methods

getMegabytesCopiedPerChunk()

public Long getMegabytesCopiedPerChunk()

Returns the maximum number of megabytes to copy for each RPC call. This parameter is ignored if source and target blob share the same location and storage class as copy is made with one single RPC.

Returns
Type	Description
`Long`

getSource()

public BlobId getSource()

Returns the blob to copy, as a BlobId.

Returns
Type	Description
`BlobId`

getSourceOptions()

public List<Storage.BlobSourceOption> getSourceOptions()

Returns blob's source options.

Returns
Type	Description
`List<BlobSourceOption>`

getTarget()

public BlobInfo getTarget()

Returns the BlobInfo for the target blob.

Returns
Type	Description
`BlobInfo`

getTargetOptions()

public List<Storage.BlobTargetOption> getTargetOptions()

Returns blob's target options.

Returns
Type	Description
`List<BlobTargetOption>`

overrideInfo()

public boolean overrideInfo()

Returns whether to override the target blob information with #getTarget(). If true, the value of #getTarget() is used to replace source blob information (e.g. contentType, contentLanguage). Target blob information is set exactly to this value, no information is inherited from the source blob. If false, target blob information is inherited from the source blob.

Returns
Type	Description
`boolean`