Backup and DR Service V1 API - Class Google::Cloud::BackupDR::V1::ListBackupPlansRequest (v0.3.0)

Reference documentation and code samples for the Backup and DR Service V1 API class Google::Cloud::BackupDR::V1::ListBackupPlansRequest.

The request message for getting a list BackupPlan.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) — Optional. Field match expression used to filter the results.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — Optional. Field match expression used to filter the results.
Returns
  • (::String) — Optional. Field match expression used to filter the results.

#order_by

def order_by() -> ::String
Returns
  • (::String) — Optional. Field by which to sort the results.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::String) — Optional. Field by which to sort the results.
Returns
  • (::String) — Optional. Field by which to sort the results.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — 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 to determine if there are more instances left to be queried.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — 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 to determine if there are more instances left to be queried.
Returns
  • (::Integer) — 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 to determine if there are more instances left to be queried.

#page_token

def page_token() -> ::String
Returns
  • (::String) — Optional. The value of 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.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — Optional. The value of 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.
Returns
  • (::String) — Optional. The value of 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.

#parent

def parent() -> ::String
Returns
  • (::String) — 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.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.