Class ObjectsResource.CopyRequest
Copies an object to a destination in the same location. Optionally overrides metadata.
Inheritance
System.Object
ObjectsResource.CopyRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Assembly: Google.Apis.Storage.v1beta2.dll
Syntax
public class CopyRequest : StorageBaseServiceRequest<Object>, IClientServiceRequest<Object>, IClientServiceRequest
Constructors
CopyRequest(IClientService, Object, String, String, String, String)
Constructs a new Copy request.
Declaration
public CopyRequest(IClientService service, Object body, string sourceBucket, string sourceObject, string destinationBucket, string destinationObject)
Parameters
Type |
Name |
Description |
IClientService |
service |
|
Object |
body |
|
System.String |
sourceBucket |
|
System.String |
sourceObject |
|
System.String |
destinationBucket |
|
System.String |
destinationObject |
|
Properties
DestinationBucket
Name of the bucket in which to store the new object. Overrides the provided object metadata's
bucket value, if any.
Declaration
[RequestParameter("destinationBucket", RequestParameterType.Path)]
public virtual string DestinationBucket { get; }
Property Value
Type |
Description |
System.String |
|
DestinationObject
Name of the new object. Required when the object metadata is not otherwise provided. Overrides
the object metadata's name value, if any.
Declaration
[RequestParameter("destinationObject", RequestParameterType.Path)]
public virtual string DestinationObject { get; }
Property Value
Type |
Description |
System.String |
|
HttpMethod
Declaration
public override string HttpMethod { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Storage.v1beta2.Data.Object>.HttpMethod
IfGenerationMatch
Makes the operation conditional on whether the destination object's current generation matches
the given value.
Declaration
[RequestParameter("ifGenerationMatch", RequestParameterType.Query)]
public virtual ulong? IfGenerationMatch { get; set; }
Property Value
Type |
Description |
System.Nullable<System.UInt64> |
|
IfGenerationNotMatch
Makes the operation conditional on whether the destination object's current generation does not
match the given value.
Declaration
[RequestParameter("ifGenerationNotMatch", RequestParameterType.Query)]
public virtual ulong? IfGenerationNotMatch { get; set; }
Property Value
Type |
Description |
System.Nullable<System.UInt64> |
|
Makes the operation conditional on whether the destination object's current metageneration
matches the given value.
Declaration
[RequestParameter("ifMetagenerationMatch", RequestParameterType.Query)]
public virtual ulong? IfMetagenerationMatch { get; set; }
Property Value
Type |
Description |
System.Nullable<System.UInt64> |
|
Makes the operation conditional on whether the destination object's current metageneration does
not match the given value.
Declaration
[RequestParameter("ifMetagenerationNotMatch", RequestParameterType.Query)]
public virtual ulong? IfMetagenerationNotMatch { get; set; }
Property Value
Type |
Description |
System.Nullable<System.UInt64> |
|
IfSourceGenerationMatch
Makes the operation conditional on whether the source object's generation matches the given
value.
Declaration
[RequestParameter("ifSourceGenerationMatch", RequestParameterType.Query)]
public virtual ulong? IfSourceGenerationMatch { get; set; }
Property Value
Type |
Description |
System.Nullable<System.UInt64> |
|
IfSourceGenerationNotMatch
Makes the operation conditional on whether the source object's generation does not match the
given value.
Declaration
[RequestParameter("ifSourceGenerationNotMatch", RequestParameterType.Query)]
public virtual ulong? IfSourceGenerationNotMatch { get; set; }
Property Value
Type |
Description |
System.Nullable<System.UInt64> |
|
Makes the operation conditional on whether the source object's current metageneration matches
the given value.
Declaration
[RequestParameter("ifSourceMetagenerationMatch", RequestParameterType.Query)]
public virtual ulong? IfSourceMetagenerationMatch { get; set; }
Property Value
Type |
Description |
System.Nullable<System.UInt64> |
|
Makes the operation conditional on whether the source object's current metageneration does not
match the given value.
Declaration
[RequestParameter("ifSourceMetagenerationNotMatch", RequestParameterType.Query)]
public virtual ulong? IfSourceMetagenerationNotMatch { get; set; }
Property Value
Type |
Description |
System.Nullable<System.UInt64> |
|
Gets the media downloader.
Declaration
public IMediaDownloader MediaDownloader { get; }
Property Value
MethodName
Declaration
public override string MethodName { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Storage.v1beta2.Data.Object>.MethodName
Projection
Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl
property, when it defaults to full.
Declaration
[RequestParameter("projection", RequestParameterType.Query)]
public virtual ObjectsResource.CopyRequest.ProjectionEnum? Projection { get; set; }
Property Value
RestPath
Declaration
public override string RestPath { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Storage.v1beta2.Data.Object>.RestPath
SourceBucket
Name of the bucket in which to find the source object.
Declaration
[RequestParameter("sourceBucket", RequestParameterType.Path)]
public virtual string SourceBucket { get; }
Property Value
Type |
Description |
System.String |
|
SourceGeneration
If present, selects a specific revision of the source object (as opposed to the latest version,
the default).
Declaration
[RequestParameter("sourceGeneration", RequestParameterType.Query)]
public virtual ulong? SourceGeneration { get; set; }
Property Value
Type |
Description |
System.Nullable<System.UInt64> |
|
SourceObject
Name of the source object.
Declaration
[RequestParameter("sourceObject", RequestParameterType.Path)]
public virtual string SourceObject { get; }
Property Value
Type |
Description |
System.String |
|
Methods
Download(Stream)
Synchronously download the media into the given stream.
Warning: This method hides download errors; use DownloadWithStatus(Stream) instead.
Declaration
public virtual void Download(Stream stream)
Parameters
Type |
Name |
Description |
System.IO.Stream |
stream |
|
DownloadAsync(Stream)
Asynchronously download the media into the given stream.
Declaration
public virtual Task<IDownloadProgress> DownloadAsync(Stream stream)
Parameters
Type |
Name |
Description |
System.IO.Stream |
stream |
|
Returns
DownloadAsync(Stream, CancellationToken)
Asynchronously download the media into the given stream.
Declaration
public virtual Task<IDownloadProgress> DownloadAsync(Stream stream, CancellationToken cancellationToken)
Parameters
Type |
Name |
Description |
System.IO.Stream |
stream |
|
System.Threading.CancellationToken |
cancellationToken |
|
Returns
Synchronously download a range of the media into the given stream.
Declaration
public virtual IDownloadProgress DownloadRange(Stream stream, RangeHeaderValue range)
Parameters
Type |
Name |
Description |
System.IO.Stream |
stream |
|
System.Net.Http.Headers.RangeHeaderValue |
range |
|
Returns
Asynchronously download a range of the media into the given stream.
Declaration
public virtual Task<IDownloadProgress> DownloadRangeAsync(Stream stream, RangeHeaderValue range, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type |
Name |
Description |
System.IO.Stream |
stream |
|
System.Net.Http.Headers.RangeHeaderValue |
range |
|
System.Threading.CancellationToken |
cancellationToken |
|
Returns
DownloadWithStatus(Stream)
Synchronously download the media into the given stream.
Declaration
public virtual IDownloadProgress DownloadWithStatus(Stream stream)
Parameters
Type |
Name |
Description |
System.IO.Stream |
stream |
|
Returns
Type |
Description |
IDownloadProgress |
The final status of the download; including whether the download succeeded or failed.
|
GetBody()
Returns the body of the request.
Declaration
protected override object GetBody()
Returns
Type |
Description |
System.Object |
|
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Storage.v1beta2.Data.Object>.GetBody()
InitParameters()
Initializes Copy parameter list.
Declaration
protected override void InitParameters()
Overrides
Google.Apis.Storage.v1beta2.StorageBaseServiceRequest<Google.Apis.Storage.v1beta2.Data.Object>.InitParameters()
Implements