Reference documentation and code samples for the Migrate for Compute Engine V1 API class Google::Cloud::VMMigration::V1::ListGroupsRequest.
Request message for 'ListGroups' request.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#filter
deffilter()->::String
Returns
(::String) — Optional. The filter request.
#filter=
deffilter=(value)->::String
Parameter
value (::String) — Optional. The filter request.
Returns
(::String) — Optional. The filter request.
#order_by
deforder_by()->::String
Returns
(::String) — Optional. the order by fields for the result.
#order_by=
deforder_by=(value)->::String
Parameter
value (::String) — Optional. the order by fields for the result.
Returns
(::String) — Optional. the order by fields for the result.
#page_size
defpage_size()->::Integer
Returns
(::Integer) — Optional. The maximum number of groups to return. The service may return
fewer than this value. If unspecified, at most 500 groups will be
returned. The maximum value is 1000; values above 1000 will be coerced to
1000.
#page_size=
defpage_size=(value)->::Integer
Parameter
value (::Integer) — Optional. The maximum number of groups to return. The service may return
fewer than this value. If unspecified, at most 500 groups will be
returned. The maximum value is 1000; values above 1000 will be coerced to
1000.
Returns
(::Integer) — Optional. The maximum number of groups to return. The service may return
fewer than this value. If unspecified, at most 500 groups will be
returned. The maximum value is 1000; values above 1000 will be coerced to
1000.
#page_token
defpage_token()->::String
Returns
(::String) — Required. A page token, received from a previous ListGroups call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListGroups must
match the call that provided the page token.
#page_token=
defpage_token=(value)->::String
Parameter
value (::String) — Required. A page token, received from a previous ListGroups call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListGroups must
match the call that provided the page token.
Returns
(::String) — Required. A page token, received from a previous ListGroups call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListGroups must
match the call that provided the page token.
#parent
defparent()->::String
Returns
(::String) — Required. The parent, which owns this collection of groups.
#parent=
defparent=(value)->::String
Parameter
value (::String) — Required. The parent, which owns this collection of groups.
Returns
(::String) — Required. The parent, which owns this collection of groups.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["# Migrate for Compute Engine V1 API - Class Google::Cloud::VMMigration::V1::ListGroupsRequest (v2.2.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.2.0 (latest)](/ruby/docs/reference/google-cloud-vm_migration-v1/latest/Google-Cloud-VMMigration-V1-ListGroupsRequest)\n- [2.1.1](/ruby/docs/reference/google-cloud-vm_migration-v1/2.1.1/Google-Cloud-VMMigration-V1-ListGroupsRequest)\n- [2.0.0](/ruby/docs/reference/google-cloud-vm_migration-v1/2.0.0/Google-Cloud-VMMigration-V1-ListGroupsRequest)\n- [1.3.0](/ruby/docs/reference/google-cloud-vm_migration-v1/1.3.0/Google-Cloud-VMMigration-V1-ListGroupsRequest)\n- [1.2.0](/ruby/docs/reference/google-cloud-vm_migration-v1/1.2.0/Google-Cloud-VMMigration-V1-ListGroupsRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-vm_migration-v1/1.1.0/Google-Cloud-VMMigration-V1-ListGroupsRequest)\n- [1.0.2](/ruby/docs/reference/google-cloud-vm_migration-v1/1.0.2/Google-Cloud-VMMigration-V1-ListGroupsRequest)\n- [0.9.0](/ruby/docs/reference/google-cloud-vm_migration-v1/0.9.0/Google-Cloud-VMMigration-V1-ListGroupsRequest)\n- [0.8.2](/ruby/docs/reference/google-cloud-vm_migration-v1/0.8.2/Google-Cloud-VMMigration-V1-ListGroupsRequest)\n- [0.7.0](/ruby/docs/reference/google-cloud-vm_migration-v1/0.7.0/Google-Cloud-VMMigration-V1-ListGroupsRequest)\n- [0.6.1](/ruby/docs/reference/google-cloud-vm_migration-v1/0.6.1/Google-Cloud-VMMigration-V1-ListGroupsRequest)\n- [0.5.0](/ruby/docs/reference/google-cloud-vm_migration-v1/0.5.0/Google-Cloud-VMMigration-V1-ListGroupsRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-vm_migration-v1/0.4.0/Google-Cloud-VMMigration-V1-ListGroupsRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-vm_migration-v1/0.3.0/Google-Cloud-VMMigration-V1-ListGroupsRequest)\n- [0.2.0](/ruby/docs/reference/google-cloud-vm_migration-v1/0.2.0/Google-Cloud-VMMigration-V1-ListGroupsRequest)\n- [0.1.1](/ruby/docs/reference/google-cloud-vm_migration-v1/0.1.1/Google-Cloud-VMMigration-V1-ListGroupsRequest) \nReference documentation and code samples for the Migrate for Compute Engine V1 API class Google::Cloud::VMMigration::V1::ListGroupsRequest.\n\nRequest message for 'ListGroups' request. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #filter\n\n def filter() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. The filter request.\n\n### #filter=\n\n def filter=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. The filter request. \n**Returns**\n\n- (::String) --- Optional. The filter request.\n\n### #order_by\n\n def order_by() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. the order by fields for the result.\n\n### #order_by=\n\n def order_by=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. the order by fields for the result. \n**Returns**\n\n- (::String) --- Optional. the order by fields for the result.\n\n### #page_size\n\n def page_size() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- Optional. The maximum number of groups to return. The service may return fewer than this value. If unspecified, at most 500 groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.\n\n### #page_size=\n\n def page_size=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- Optional. The maximum number of groups to return. The service may return fewer than this value. If unspecified, at most 500 groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. \n**Returns**\n\n- (::Integer) --- Optional. The maximum number of groups to return. The service may return fewer than this value. If unspecified, at most 500 groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.\n\n### #page_token\n\n def page_token() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. A page token, received from a previous `ListGroups` call. Provide this to retrieve the subsequent page.\n\n\n When paginating, all other parameters provided to `ListGroups` must\n match the call that provided the page token.\n\n### #page_token=\n\n def page_token=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. A page token, received from a previous `ListGroups` call. Provide this to retrieve the subsequent page.\n\n\n When paginating, all other parameters provided to `ListGroups` must\nmatch the call that provided the page token. \n**Returns**\n\n- (::String) --- Required. A page token, received from a previous `ListGroups` call. Provide this to retrieve the subsequent page.\n\n\n When paginating, all other parameters provided to `ListGroups` must\n match the call that provided the page token.\n\n### #parent\n\n def parent() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The parent, which owns this collection of groups.\n\n### #parent=\n\n def parent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The parent, which owns this collection of groups. \n**Returns**\n\n- (::String) --- Required. The parent, which owns this collection of groups."]]
