Storage.CopyRequest (Storage Parent 2.24.0 API)

java.lang.Object
- com.google.cloud.storage.Storage.CopyRequest

All Implemented Interfaces:

Serializable

Enclosing interface:

Storage
```
@TransportCompatibility(value={HTTP,GRPC})
public static class Storage.CopyRequest
extends Object
implements Serializable
```
A class to contain all information needed for a Google Cloud Storage Copy operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Storage.CopyRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`Storage.CopyRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`getMegabytesCopiedPerChunk()` Returns the maximum number of megabytes to copy for each RPC call.
`BlobId`	`getSource()` Returns the blob to copy, as a `BlobId`.
`List<Storage.BlobSourceOption>`	`getSourceOptions()` Returns blob's source options.
`BlobInfo`	`getTarget()` Returns the `BlobInfo` for the target blob.
`List<Storage.BlobTargetOption>`	`getTargetOptions()` Returns blob's target options.
`static Storage.CopyRequest.Builder`	`newBuilder()` Creates a builder for `CopyRequest` objects.
`static Storage.CopyRequest`	`of(BlobId sourceBlobId, BlobId targetBlobId)` Creates a copy request.
`static Storage.CopyRequest`	`of(BlobId sourceBlobId, BlobInfo target)` Creates a copy request.
`static Storage.CopyRequest`	`of(BlobId sourceBlobId, String targetBlob)` Creates a copy request.
`static Storage.CopyRequest`	`of(String sourceBucket, String sourceBlob, BlobId target)` Creates a copy request.
`static Storage.CopyRequest`	`of(String sourceBucket, String sourceBlob, BlobInfo target)` Creates a copy request.
`static Storage.CopyRequest`	`of(String sourceBucket, String sourceBlob, String targetBlob)` Creates a copy request.
`boolean`	`overrideInfo()` Returns whether to override the target blob information with `getTarget()`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getSource
```
public BlobId getSource()
```
    Returns the blob to copy, as a BlobId.
  - getSourceOptions
```
public List<Storage.BlobSourceOption> getSourceOptions()
```
    Returns blob's source options.
  - getTarget
```
public BlobInfo getTarget()
```
    Returns the BlobInfo for the target blob.
  - 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.
  - getTargetOptions
```
public List<Storage.BlobTargetOption> getTargetOptions()
```
    Returns blob's target options.
  - 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.
  - of
```
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:
    
    sourceBucket - name of the bucket containing the source blob
    
    sourceBlob - name of the source blob
    
    target - a BlobInfo object for the target blob
    
    Returns:
    
    a copy request
  - of
```
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:
    
    sourceBlobId - a BlobId object for the source blob
    
    target - a BlobInfo object for the target blob
    
    Returns:
    
    a copy request
  - of
```
public static Storage.CopyRequest of(String sourceBucket,
                                     String sourceBlob,
                                     String targetBlob)
```
    Creates a copy request. Target blob information is copied from source.
    
    Parameters:
    
    sourceBucket - name of the bucket containing both the source and the target blob
    
    sourceBlob - name of the source blob
    
    targetBlob - name of the target blob
    
    Returns:
    
    a copy request
  - of
```
public static Storage.CopyRequest of(String sourceBucket,
                                     String sourceBlob,
                                     BlobId target)
```
    Creates a copy request. Target blob information is copied from source.
    
    Parameters:
    
    sourceBucket - name of the bucket containing the source blob
    
    sourceBlob - name of the source blob
    
    target - a BlobId object for the target blob
    
    Returns:
    
    a copy request
  - of
```
public static Storage.CopyRequest of(BlobId sourceBlobId,
                                     String targetBlob)
```
    Creates a copy request. Target blob information is copied from source.
    
    Parameters:
    
    sourceBlobId - a BlobId object for the source blob
    
    targetBlob - name of the target blob, in the same bucket of the source blob
    
    Returns:
    
    a copy request
  - of
```
public static Storage.CopyRequest of(BlobId sourceBlobId,
                                     BlobId targetBlobId)
```
    Creates a copy request. Target blob information is copied from source.
    
    Parameters:
    
    sourceBlobId - a BlobId object for the source blob
    
    targetBlobId - a BlobId object for the target blob
    
    Returns:
    
    a copy request
  - newBuilder
```
public static Storage.CopyRequest.Builder newBuilder()
```
    Creates a builder for CopyRequest objects.

Class Storage.CopyRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getSource

getSourceOptions

getTarget

overrideInfo

getTargetOptions

getMegabytesCopiedPerChunk

of

of

of

of

of

of

newBuilder