Class ObjectsResource.ListRequest

Retrieves a list of objects matching the criteria.

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<Objects>
StorageBaseServiceRequest<Objects>
ObjectsResource.ListRequest
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()
Namespace: Google.Apis.Storage.v1
Assembly: Google.Apis.Storage.v1.dll
Syntax
public class ListRequest : StorageBaseServiceRequest<Objects>, IClientServiceRequest<Objects>, IClientServiceRequest

Constructors

ListRequest(IClientService, String)

Constructs a new List request.

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

Properties

Bucket

Name of the bucket in which to look for objects.

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

Delimiter

Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.

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

EndOffset

Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects 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
System.String

HttpMethod

Gets the HTTP method.

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

IncludeTrailingDelimiter

If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.

Declaration
[RequestParameter("includeTrailingDelimiter", RequestParameterType.Query)]
public virtual bool? IncludeTrailingDelimiter { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

MaxResults

Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.

Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual long? MaxResults { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

MethodName

Gets the method name.

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

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
System.String

Prefix

Filter results to objects whose names begin with this prefix.

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

Projection

Set of properties to return. Defaults to noAcl.

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

ProvisionalUserProject

The project to be billed for this request if the target bucket is requester-pays bucket.

Declaration
[RequestParameter("provisionalUserProject", RequestParameterType.Query)]
public virtual string ProvisionalUserProject { get; set; }
Property Value
Type Description
System.String

RestPath

Gets the REST path.

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

StartOffset

Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects 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
System.String

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
System.String

Versions

If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.

Declaration
[RequestParameter("versions", RequestParameterType.Query)]
public virtual bool? Versions { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

Methods

InitParameters()

Initializes List parameter list.

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

Implements