Retrieves a list of objects matching the criteria. More...

Inheritance diagram for Google.Apis.Storage.v1.ObjectsResource.ListRequest:

Public Types
enum	ProjectionEnum { ProjectionEnum.Full, ProjectionEnum.NoAcl }
	Set of properties to return. Defaults to noAcl. More...

Public Member Functions
	ListRequest (Google.Apis.Services.IClientService service, string bucket)
	Constructs a new List request. More...

Protected Member Functions
override void	InitParameters ()
	Initializes List parameter list. More...

Protected Member Functions inherited from Google.Apis.Storage.v1.StorageBaseServiceRequest< Google.Apis.Storage.v1.Data.Objects >
	StorageBaseServiceRequest (Google.Apis.Services.IClientService service)
	Constructs a new StorageBaseServiceRequest instance. More...

override void	InitParameters ()
	Initializes Storage parameter list. More...

Properties
virtual string	Bucket `[get]`
	Name of the bucket in which to look for objects. More...

virtual string	Delimiter `[get, set]`
	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. More...

virtual string	EndOffset `[get, set]`
	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). More...

virtual System.Nullable< bool >	IncludeTrailingDelimiter `[get, set]`
	If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes. More...

virtual System.Nullable< long >	MaxResults `[get, set]`
	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. More...

virtual string	PageToken `[get, set]`
	A previously-returned page token representing part of the larger set of results to view. More...

virtual string	Prefix `[get, set]`
	Filter results to objects whose names begin with this prefix. More...

virtual System.Nullable< ProjectionEnum >	Projection `[get, set]`
	Set of properties to return. Defaults to noAcl. More...

virtual string	ProvisionalUserProject `[get, set]`
	The project to be billed for this request if the target bucket is requester-pays bucket. More...

virtual string	StartOffset `[get, set]`
	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). More...

virtual string	UserProject `[get, set]`
	The project to be billed for this request. Required for Requester Pays buckets. More...

virtual System.Nullable< bool >	Versions `[get, set]`
	If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. More...

override string	MethodName `[get]`
	summary>Gets the HTTP method. More...

override string	HttpMethod `[get]`
	summary>Gets the REST path. More...

override string	RestPath `[get]`

Properties inherited from Google.Apis.Storage.v1.StorageBaseServiceRequest< Google.Apis.Storage.v1.Data.Objects >
virtual System.Nullable< AltEnum >	Alt `[get, set]`
	Data format for the response. More...

virtual string	Fields `[get, set]`
	Selector specifying which fields to include in a partial response. More...

virtual string	Key `[get, set]`
	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. More...

virtual string	OauthToken `[get, set]`
	OAuth 2.0 token for the current user. More...

virtual System.Nullable< bool >	PrettyPrint `[get, set]`
	Returns response with indentations and line breaks. More...

virtual string	QuotaUser `[get, set]`
	An opaque string that represents a user for quota purposes. Must not exceed 40 characters. More...

virtual string	UserIp `[get, set]`
	Deprecated. Please use quotaUser instead. More...

Detailed Description

Retrieves a list of objects matching the criteria.

Member Enumeration Documentation

◆ ProjectionEnum

enum Google.Apis.Storage.v1.ObjectsResource.ListRequest.ProjectionEnum

strong

Set of properties to return. Defaults to noAcl.

Enumerator
Full	Include all properties.
NoAcl	Omit the owner, acl property.

Constructor & Destructor Documentation

◆ ListRequest()

Google.Apis.Storage.v1.ObjectsResource.ListRequest.ListRequest	(	Google.Apis.Services.IClientService	service,
		string	bucket
	)

inline

Constructs a new List request.

Member Function Documentation

◆ InitParameters()

override void Google.Apis.Storage.v1.ObjectsResource.ListRequest.InitParameters ( )

inlineprotected

Initializes List parameter list.

Property Documentation

◆ Bucket

virtual string Google.Apis.Storage.v1.ObjectsResource.ListRequest.Bucket

get

Name of the bucket in which to look for objects.

◆ Delimiter

virtual string Google.Apis.Storage.v1.ObjectsResource.ListRequest.Delimiter

getset

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.

◆ EndOffset

virtual string Google.Apis.Storage.v1.ObjectsResource.ListRequest.EndOffset

getset

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

◆ HttpMethod

override string Google.Apis.Storage.v1.ObjectsResource.ListRequest.HttpMethod

get

summary>Gets the REST path.

◆ IncludeTrailingDelimiter

virtual System.Nullable<bool> Google.Apis.Storage.v1.ObjectsResource.ListRequest.IncludeTrailingDelimiter

getset

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

◆ MaxResults

virtual System.Nullable<long> Google.Apis.Storage.v1.ObjectsResource.ListRequest.MaxResults

getset

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.

[default: 1000] [minimum: 0]

◆ MethodName

override string Google.Apis.Storage.v1.ObjectsResource.ListRequest.MethodName

get

summary>Gets the HTTP method.

◆ PageToken

virtual string Google.Apis.Storage.v1.ObjectsResource.ListRequest.PageToken

getset

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

◆ Prefix

virtual string Google.Apis.Storage.v1.ObjectsResource.ListRequest.Prefix

getset

Filter results to objects whose names begin with this prefix.

◆ Projection

virtual System.Nullable<ProjectionEnum> Google.Apis.Storage.v1.ObjectsResource.ListRequest.Projection

getset

Set of properties to return. Defaults to noAcl.

◆ ProvisionalUserProject

virtual string Google.Apis.Storage.v1.ObjectsResource.ListRequest.ProvisionalUserProject

getset

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

◆ StartOffset

virtual string Google.Apis.Storage.v1.ObjectsResource.ListRequest.StartOffset

getset

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

◆ UserProject

virtual string Google.Apis.Storage.v1.ObjectsResource.ListRequest.UserProject

getset

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

◆ Versions

virtual System.Nullable<bool> Google.Apis.Storage.v1.ObjectsResource.ListRequest.Versions

getset

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

summary>Gets the method name.

The documentation for this class was generated from the following file:

Google.Apis.Storage.v1.cs

Public Types

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ ProjectionEnum

Constructor & Destructor Documentation

◆ ListRequest()

Member Function Documentation

◆ InitParameters()

Property Documentation

◆ Bucket

◆ Delimiter

◆ EndOffset

◆ HttpMethod

◆ IncludeTrailingDelimiter

◆ MaxResults

◆ MethodName

◆ PageToken

◆ Prefix

◆ Projection

◆ ProvisionalUserProject

◆ StartOffset

◆ UserProject

◆ Versions