Class ObjectsResource.ComposeRequest
Concatenates a list of existing objects into a new object in the same bucket.
Inheritance
System.Object
ObjectsResource.ComposeRequest
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 ComposeRequest : StorageBaseServiceRequest<Object>, IClientServiceRequest<Object>, IClientServiceRequest
Constructors
ComposeRequest(IClientService, ComposeRequest, String, String)
Constructs a new Compose request.
Declaration
public ComposeRequest(IClientService service, ComposeRequest body, string destinationBucket, string destinationObject)
Parameters
Properties
DestinationBucket
Name of the bucket containing the source objects. The destination object is stored in this
bucket.
Declaration
[RequestParameter("destinationBucket", RequestParameterType.Path)]
public virtual string DestinationBucket { get; }
Property Value
Type |
Description |
System.String |
|
DestinationObject
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 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> |
|
Makes the operation conditional on whether the 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> |
|
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
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
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 Compose parameter list.
Declaration
protected override void InitParameters()
Overrides
Google.Apis.Storage.v1beta2.StorageBaseServiceRequest<Google.Apis.Storage.v1beta2.Data.Object>.InitParameters()
Implements