Class FoldersResource.ListRequest

Retrieves a list of folders matching the criteria. Only applicable to buckets with hierarchical namespace enabled.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Folders>
StorageBaseServiceRequest<Folders>
FoldersResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Storage.v1
Assembly: Google.Apis.Storage.v1.dll
Syntax
public class FoldersResource.ListRequest : StorageBaseServiceRequest<Folders>, IClientServiceRequest<Folders>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

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

Properties

Bucket

Name of the bucket in which to look for folders.

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

Delimiter

Returns results in a directory-like mode. The only supported value is '/'. If set, items will only contain folders that either exactly match the prefix, or are one level below the prefix.

Declaration
[RequestParameter("delimiter", RequestParameterType.Query)]
public virtual string Delimiter { get; set; }
Property Value
Type Description
string

EndOffset

Filter results to folders whose names are lexicographically before endOffset. If startOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).

Declaration
[RequestParameter("endOffset", RequestParameterType.Query)]
public virtual string EndOffset { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

PageSize

Maximum number of items to return in a single page of responses.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

A previously-returned page token representing part of the larger set of results to view.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Prefix

Filter results to folders whose paths begin with this prefix. If set, the value must either be an empty string or end with a '/'.

Declaration
[RequestParameter("prefix", RequestParameterType.Query)]
public virtual string Prefix { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

StartOffset

Filter results to folders whose names are lexicographically equal to or after startOffset. If endOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).

Declaration
[RequestParameter("startOffset", RequestParameterType.Query)]
public virtual string StartOffset { get; set; }
Property Value
Type Description
string

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements