Class ObjectsResource.GetRequest

Retrieves an object or its metadata.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Object>
StorageBaseServiceRequest<Object>
ObjectsResource.GetRequest
Implements
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Storage.v1
Assembly: Google.Apis.Storage.v1.dll
Syntax
public class ObjectsResource.GetRequest : StorageBaseServiceRequest<Object>, IClientServiceRequest<Object>, IClientServiceRequest

Constructors

GetRequest(IClientService, string, string)

Constructs a new Get request.

Declaration
public GetRequest(IClientService service, string bucket, string storageObject)
Parameters
Type Name Description
IClientService service
string bucket
string storageObject

Properties

Bucket

Name of the bucket in which the object resides.

Declaration
[RequestParameter("bucket", RequestParameterType.Path)]
public virtual string Bucket { get; }
Property Value
Type Description
string

Generation

If present, selects a specific revision of this object (as opposed to the latest version, the default).

Declaration
[RequestParameter("generation", RequestParameterType.Query)]
public virtual long? Generation { get; set; }
Property Value
Type Description
long?

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Storage.v1.Data.Object>.HttpMethod

IfGenerationMatch

Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.

Declaration
[RequestParameter("ifGenerationMatch", RequestParameterType.Query)]
public virtual long? IfGenerationMatch { get; set; }
Property Value
Type Description
long?

IfGenerationNotMatch

Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.

Declaration
[RequestParameter("ifGenerationNotMatch", RequestParameterType.Query)]
public virtual long? IfGenerationNotMatch { get; set; }
Property Value
Type Description
long?

IfMetagenerationMatch

Makes the operation conditional on whether the object's current metageneration matches the given value.

Declaration
[RequestParameter("ifMetagenerationMatch", RequestParameterType.Query)]
public virtual long? IfMetagenerationMatch { get; set; }
Property Value
Type Description
long?

IfMetagenerationNotMatch

Makes the operation conditional on whether the object's current metageneration does not match the given value.

Declaration
[RequestParameter("ifMetagenerationNotMatch", RequestParameterType.Query)]
public virtual long? IfMetagenerationNotMatch { get; set; }
Property Value
Type Description
long?

MediaDownloader

Gets the media downloader.

Declaration
public IMediaDownloader MediaDownloader { get; }
Property Value
Type Description
IMediaDownloader

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Storage.v1.Data.Object>.MethodName

Object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

Declaration
[RequestParameter("object", RequestParameterType.Path)]
public virtual string Object { get; }
Property Value
Type Description
string

Projection

Set of properties to return. Defaults to noAcl.

Declaration
[RequestParameter("projection", RequestParameterType.Query)]
public virtual ObjectsResource.GetRequest.ProjectionEnum? Projection { get; set; }
Property Value
Type Description
ObjectsResource.GetRequest.ProjectionEnum?

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Storage.v1.Data.Object>.RestPath

UserProject

The project to be billed for this request. Required for Requester Pays buckets.

Declaration
[RequestParameter("userProject", RequestParameterType.Query)]
public virtual string UserProject { get; set; }
Property Value
Type Description
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
Remarks

This method uses the MediaDownloader property to perform the download. Progress event handlers and other configuration may be performed using that property prior to calling this method.

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
Type Description
System.Threading.Tasks.Task<TResult><IDownloadProgress>
Remarks

This method uses the MediaDownloader property to perform the download. Progress event handlers and other configuration may be performed using that property prior to calling this method.

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
Type Description
System.Threading.Tasks.Task<TResult><IDownloadProgress>
Remarks

This method uses the MediaDownloader property to perform the download. Progress event handlers and other configuration may be performed using that property prior to calling this method.

DownloadRange(Stream, RangeHeaderValue)

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
Type Description
IDownloadProgress
Remarks

This method uses the MediaDownloader property to perform the download. Progress event handlers and other configuration may be performed using that property prior to calling this method.

DownloadRangeAsync(Stream, RangeHeaderValue, CancellationToken)

Asynchronously download a range of the media into the given stream.

Declaration
public virtual Task<IDownloadProgress> DownloadRangeAsync(Stream stream, RangeHeaderValue range, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.IO.Stream stream
System.Net.Http.Headers.RangeHeaderValue range
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<TResult><IDownloadProgress>
Remarks

This method uses the MediaDownloader property to perform the download. Progress event handlers and other configuration may be performed using that property prior to calling this method.

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.
Remarks

This method uses the MediaDownloader property to perform the download. Progress event handlers and other configuration may be performed using that property prior to calling this method.

InitParameters()

Initializes Get parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Storage.v1.StorageBaseServiceRequest<Google.Apis.Storage.v1.Data.Object>.InitParameters()

Implements