Backup and DR Service v1 API - Class ListBackupPlansRequest (1.2.0)

public sealed class ListBackupPlansRequest : IPageRequest, IMessage<ListBackupPlansRequest>, IEquatable<ListBackupPlansRequest>, IDeepCloneable<ListBackupPlansRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Backup and DR Service v1 API class ListBackupPlansRequest.

The request message for getting a list BackupPlan.

Inheritance

object > ListBackupPlansRequest

Implements

IPageRequest, IMessage ListBackupPlansRequest, IEquatable ListBackupPlansRequest, IDeepCloneable ListBackupPlansRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.BackupDR.V1

Assembly

Google.Cloud.BackupDR.V1.dll

Constructors

ListBackupPlansRequest()

public ListBackupPlansRequest()

ListBackupPlansRequest(ListBackupPlansRequest)

public ListBackupPlansRequest(ListBackupPlansRequest other)

Parameter
Name	Description
`other`	`ListBackupPlansRequest`

Properties

Filter

public string Filter { get; set; }

Optional. Field match expression used to filter the results.

Property Value
Type	Description
`string`

OrderBy

public string OrderBy { get; set; }

Optional. Field by which to sort the results.

Property Value
Type	Description
`string`

PageSize

public int PageSize { get; set; }

Optional. The maximum number of BackupPlans to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's [next_page_token][google.cloud.backupdr.v1.ListBackupPlansResponse.next_page_token] to determine if there are more instances left to be queried.

Property Value
Type	Description
`int`

PageToken

public string PageToken { get; set; }

Optional. The value of [next_page_token][google.cloud.backupdr.v1.ListBackupPlansResponse.next_page_token] received from a previous ListBackupPlans call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListBackupPlans must match the call that provided the page token.

Property Value
Type	Description
`string`

Parent

public string Parent { get; set; }

Required. The project and location for which to retrieve BackupPlans information. Format: projects/{project}/locations/{location}. In Cloud BackupDR, locations map to GCP regions, for e.g. us-central1. To retrieve backup plans for all locations, use "-" for the {location} value.

Property Value
Type	Description
`string`

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type	Description
`LocationName`