Class ProjectsResource.InstancesResource.ClustersResource.BackupsResource.ListRequest

Lists Cloud Bigtable backups. Returns both completed and pending backups.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListBackupsResponse>
BigtableAdminBaseServiceRequest<ListBackupsResponse>
ProjectsResource.InstancesResource.ClustersResource.BackupsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.BigtableAdmin.v2
Assembly: Google.Apis.BigtableAdmin.v2.dll
Syntax
public class ProjectsResource.InstancesResource.ClustersResource.BackupsResource.ListRequest : BigtableAdminBaseServiceRequest<ListBackupsResponse>, IClientServiceRequest<ListBackupsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

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

Properties

Filter

A filter expression that filters backups listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be &lt;, &gt;, &lt;=, &gt;=, !=, =, or :. Colon ':' represents a HAS operator which is roughly synonymous with equality. Filter rules are case insensitive. The fields eligible for filtering are: * name * source_table * state * start_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * end_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) * size_bytes To filter on multiple expressions, provide each separate expression within parentheses. By default, each expression is an AND expression. However, you can include AND, OR, and NOT expressions explicitly. Some examples of using filters are: * name:"exact" --&gt; The backup's name is the string "exact". * name:howl --&gt; The backup's name contains the string "howl". * source_table:prod --&gt; The source_table's name contains the string "prod". * state:CREATING --&gt; The backup is pending creation. * state:READY --&gt; The backup is fully created and ready for use. * (name:howl) AND (start_time &lt; \"2018-03-28T14:50:00Z\") --&gt; The backup name contains the string "howl" and start_time of the backup is before 2018-03-28T14:50:00Z. * size_bytes &gt; 10000000000 --&gt; The backup's size is greater than 10GB

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

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.BigtableAdmin.v2.Data.ListBackupsResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.BigtableAdmin.v2.Data.ListBackupsResponse>.MethodName

OrderBy

An expression for specifying the sort order of the results of the request. The string value should specify one or more fields in Backup. The full syntax is described at https://aip.dev/132#ordering. Fields supported are: * name * source_table * expire_time * start_time * end_time * size_bytes * state For example, "start_time". The default sorting order is ascending. To specify descending order for the field, a suffix " desc" should be appended to the field name. For example, "start_time desc". Redundant space characters in the syntax are insigificant. If order_by is empty, results will be sorted by start_time in descending order starting from the most recently created backup.

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

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
int?

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
string

Parent

Required. The cluster to list backups from. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}. Use {cluster} = '-' to list backups for all clusters in an instance, e.g., projects/{project}/instances/{instance}/clusters/-.

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

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.BigtableAdmin.v2.Data.ListBackupsResponse>.RestPath

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements