GitHttpClientBase.GetBlobZipAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
GetBlobZipAsync(String, Guid, String, Nullable<Boolean>, String, Nullable<Boolean>, Object, CancellationToken)
[Preview API] Get a single blob.
public virtual System.Threading.Tasks.Task<System.IO.Stream> GetBlobZipAsync(string project, Guid repositoryId, string sha1, Nullable<bool> download = null, string fileName = null, Nullable<bool> resolveLfs = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetBlobZipAsync : string * Guid * string * Nullable<bool> * string * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Parameters
- project
- String
Project ID or project name
- repositoryId
- Guid
The name or ID of the repository.
- sha1
- String
SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.
If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip
- fileName
- String
Provide a fileName to use for a download.
If true, try to resolve a blob to its LFS contents, if it's an LFS pointer file. Only compatible with octet-stream Accept headers or $format types
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetBlobZipAsync(String, String, String, Nullable<Boolean>, String, Nullable<Boolean>, Object, CancellationToken)
[Preview API] Get a single blob.
public virtual System.Threading.Tasks.Task<System.IO.Stream> GetBlobZipAsync(string project, string repositoryId, string sha1, Nullable<bool> download = null, string fileName = null, Nullable<bool> resolveLfs = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetBlobZipAsync : string * string * string * Nullable<bool> * string * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Parameters
- project
- String
Project ID or project name
- repositoryId
- String
The name or ID of the repository.
- sha1
- String
SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.
If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip
- fileName
- String
Provide a fileName to use for a download.
If true, try to resolve a blob to its LFS contents, if it's an LFS pointer file. Only compatible with octet-stream Accept headers or $format types
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetBlobZipAsync(Guid, String, String, Nullable<Boolean>, String, Nullable<Boolean>, Object, CancellationToken)
[Preview API] Get a single blob.
public virtual System.Threading.Tasks.Task<System.IO.Stream> GetBlobZipAsync(Guid project, string repositoryId, string sha1, Nullable<bool> download = null, string fileName = null, Nullable<bool> resolveLfs = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetBlobZipAsync : Guid * string * string * Nullable<bool> * string * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Parameters
- project
- Guid
Project ID
- repositoryId
- String
The name or ID of the repository.
- sha1
- String
SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.
If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip
- fileName
- String
Provide a fileName to use for a download.
If true, try to resolve a blob to its LFS contents, if it's an LFS pointer file. Only compatible with octet-stream Accept headers or $format types
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetBlobZipAsync(Guid, Guid, String, Nullable<Boolean>, String, Nullable<Boolean>, Object, CancellationToken)
[Preview API] Get a single blob.
public virtual System.Threading.Tasks.Task<System.IO.Stream> GetBlobZipAsync(Guid project, Guid repositoryId, string sha1, Nullable<bool> download = null, string fileName = null, Nullable<bool> resolveLfs = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetBlobZipAsync : Guid * Guid * string * Nullable<bool> * string * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Parameters
- project
- Guid
Project ID
- repositoryId
- Guid
The name or ID of the repository.
- sha1
- String
SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.
If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip
- fileName
- String
Provide a fileName to use for a download.
If true, try to resolve a blob to its LFS contents, if it's an LFS pointer file. Only compatible with octet-stream Accept headers or $format types
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetBlobZipAsync(String, String, String, Nullable<Boolean>, String, Object, CancellationToken)
Get a single blob.
public virtual System.Threading.Tasks.Task<System.IO.Stream> GetBlobZipAsync(string project, string repositoryId, string sha1, Nullable<bool> download = null, string fileName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetBlobZipAsync : string * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>
override this.GetBlobZipAsync : string * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Parameters
- project
- String
Project ID or project name
- repositoryId
- String
The name or ID of the repository.
- sha1
- String
SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.
If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip
- fileName
- String
Provide a fileName to use for a download.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetBlobZipAsync(String, String, Nullable<Boolean>, String, Nullable<Boolean>, Object, CancellationToken)
[Preview API] Get a single blob.
public virtual System.Threading.Tasks.Task<System.IO.Stream> GetBlobZipAsync(string repositoryId, string sha1, Nullable<bool> download = null, string fileName = null, Nullable<bool> resolveLfs = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetBlobZipAsync : string * string * Nullable<bool> * string * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Parameters
- repositoryId
- String
The name or ID of the repository.
- sha1
- String
SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.
If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip
- fileName
- String
Provide a fileName to use for a download.
If true, try to resolve a blob to its LFS contents, if it's an LFS pointer file. Only compatible with octet-stream Accept headers or $format types
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetBlobZipAsync(String, String, Nullable<Boolean>, String, Object, CancellationToken)
Get a single blob.
public virtual System.Threading.Tasks.Task<System.IO.Stream> GetBlobZipAsync(string repositoryId, string sha1, Nullable<bool> download = null, string fileName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetBlobZipAsync : string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>
override this.GetBlobZipAsync : string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Parameters
- repositoryId
- String
The name or ID of the repository.
- sha1
- String
SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.
If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip
- fileName
- String
Provide a fileName to use for a download.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetBlobZipAsync(Guid, String, String, Nullable<Boolean>, String, Object, CancellationToken)
Get a single blob.
public virtual System.Threading.Tasks.Task<System.IO.Stream> GetBlobZipAsync(Guid project, string repositoryId, string sha1, Nullable<bool> download = null, string fileName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetBlobZipAsync : Guid * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>
override this.GetBlobZipAsync : Guid * string * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Parameters
- project
- Guid
Project ID
- repositoryId
- String
The name or ID of the repository.
- sha1
- String
SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.
If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip
- fileName
- String
Provide a fileName to use for a download.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetBlobZipAsync(Guid, String, Nullable<Boolean>, String, Nullable<Boolean>, Object, CancellationToken)
[Preview API] Get a single blob.
public virtual System.Threading.Tasks.Task<System.IO.Stream> GetBlobZipAsync(Guid repositoryId, string sha1, Nullable<bool> download = null, string fileName = null, Nullable<bool> resolveLfs = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);override this.GetBlobZipAsync : Guid * string * Nullable<bool> * string * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Parameters
- repositoryId
- Guid
The name or ID of the repository.
- sha1
- String
SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.
If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip
- fileName
- String
Provide a fileName to use for a download.
If true, try to resolve a blob to its LFS contents, if it's an LFS pointer file. Only compatible with octet-stream Accept headers or $format types
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetBlobZipAsync(Guid, Guid, String, Nullable<Boolean>, String, Object, CancellationToken)
Get a single blob.
public virtual System.Threading.Tasks.Task<System.IO.Stream> GetBlobZipAsync(Guid project, Guid repositoryId, string sha1, Nullable<bool> download = null, string fileName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetBlobZipAsync : Guid * Guid * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>
override this.GetBlobZipAsync : Guid * Guid * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Parameters
- project
- Guid
Project ID
- repositoryId
- Guid
The name or ID of the repository.
- sha1
- String
SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.
If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip
- fileName
- String
Provide a fileName to use for a download.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetBlobZipAsync(Guid, String, Nullable<Boolean>, String, Object, CancellationToken)
Get a single blob.
public virtual System.Threading.Tasks.Task<System.IO.Stream> GetBlobZipAsync(Guid repositoryId, string sha1, Nullable<bool> download = null, string fileName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetBlobZipAsync : Guid * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>
override this.GetBlobZipAsync : Guid * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Parameters
- repositoryId
- Guid
The name or ID of the repository.
- sha1
- String
SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.
If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip
- fileName
- String
Provide a fileName to use for a download.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.
Returns
Applies to
GetBlobZipAsync(String, Guid, String, Nullable<Boolean>, String, Object, CancellationToken)
Get a single blob.
public virtual System.Threading.Tasks.Task<System.IO.Stream> GetBlobZipAsync(string project, Guid repositoryId, string sha1, Nullable<bool> download = null, string fileName = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member GetBlobZipAsync : string * Guid * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>
override this.GetBlobZipAsync : string * Guid * string * Nullable<bool> * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Parameters
- project
- String
Project ID or project name
- repositoryId
- Guid
The name or ID of the repository.
- sha1
- String
SHA1 hash of the file. You can get the SHA1 of a file using the "Git/Items/Get Item" endpoint.
If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip
- fileName
- String
Provide a fileName to use for a download.
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.