Class: Google::Cloud::BackupDR::V1::ListBackupPlansRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/backupdr/v1/backupplan.rb

Overview

The request message for getting a list BackupPlan.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns Optional. Field match expression used to filter the results.

Returns:

  • (::String) —

    Optional. Field match expression used to filter the results.



343
344
345
346
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 343

class ListBackupPlansRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_by ⇒ ::String

Returns Optional. Field by which to sort the results.

Returns:

  • (::String) —

    Optional. Field by which to sort the results.



343
344
345
346
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 343

class ListBackupPlansRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

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



343
344
345
346
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 343

class ListBackupPlansRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

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



343
344
345
346
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 343

class ListBackupPlansRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

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



343
344
345
346
 
# File 'proto_docs/google/cloud/backupdr/v1/backupplan.rb', line 343

class ListBackupPlansRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end