Class ProjectsResource.InstancesResource.BackupsResource.ListRequest
Lists completed and pending backups. Backups returned are ordered by create_time in descending
order, starting from the most recent create_time.
Inheritance
Inherited Members
Namespace: Google.Apis.Spanner.v1
Assembly: Google.Apis.Spanner.v1.dll
Syntax
public class ListRequest : SpannerBaseServiceRequest<ListBackupsResponse>, IClientServiceRequest<ListBackupsResponse>, IClientServiceRequestConstructors
ListRequest(IClientService, String)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string parent)Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service | |
| System.String | parent |
Properties
Filter
An expression that filters the list of returned backups. A filter expression consists of a field
name, a comparison operator, and a value for filtering. The value must be a string, a number, or
a boolean. The comparison operator must be one of: &lt;, &gt;, &lt;=,
&gt;=, !=, =, or :. Colon : is the contains operator. Filter rules are not case
sensitive. The following fields in the Backup are eligible for filtering: * name * database
state*create_time(and values are of the format YYYY-MM-DDTHH:MM:SSZ) *expire_time(and values are of the format YYYY-MM-DDTHH:MM:SSZ) *version_time(and values are of the format YYYY-MM-DDTHH:MM:SSZ) *size_bytesYou can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: *name:Howl- The backup's name contains the string "howl". *database:prod- The database's name contains the string "prod". *state:CREATING- The backup is pending creation. *state:READY- The backup is fully created and ready for use. *(name:howl) AND (create_time &lt; \"2018-03-28T14:50:00Z\")- The backup name contains the string "howl" andcreate_timeof the backup is before 2018-03-28T14:50:00Z. *expire_time &lt; \"2018-03-28T14:50:00Z\"- The backupexpire_timeis before 2018-03-28T14:50:00Z. *size_bytes &gt; 10000000000- The backup's size is greater than 10GB
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { 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
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
PageSize
Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
PageToken
If non-empty, page_token should contain a next_page_token from a previous ListBackupsResponse
to the same parent and with the same filter.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Parent
Required. The instance to list backups from. Values are of the form projects//instances/.
Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }Property Value
| Type | Description |
|---|---|
| System.String |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()