Reference documentation and code samples for the Cloud Database Migration Service V1 API class Google::Cloud::CloudDMS::V1::ListPrivateConnectionsRequest.
Request message to retrieve a list of private connections in a given project
and location.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#filter
deffilter()->::String
Returns
(::String) — A filter expression that filters private connections 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 either
=, !=, >, or <. For example, list private connections created this year by
specifying createTime %gt; 2021-01-01T00:00:00.000000000Z.
#filter=
deffilter=(value)->::String
Parameter
value (::String) — A filter expression that filters private connections 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 either
=, !=, >, or <. For example, list private connections created this year by
specifying createTime %gt; 2021-01-01T00:00:00.000000000Z.
Returns
(::String) — A filter expression that filters private connections 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 either
=, !=, >, or <. For example, list private connections created this year by
specifying createTime %gt; 2021-01-01T00:00:00.000000000Z.
#order_by
deforder_by()->::String
Returns
(::String) — Order by fields for the result.
#order_by=
deforder_by=(value)->::String
Parameter
value (::String) — Order by fields for the result.
Returns
(::String) — Order by fields for the result.
#page_size
defpage_size()->::Integer
Returns
(::Integer) — Maximum number of private connections to return.
If unspecified, at most 50 private connections that are returned.
The maximum value is 1000; values above 1000 are coerced to 1000.
#page_size=
defpage_size=(value)->::Integer
Parameter
value (::Integer) — Maximum number of private connections to return.
If unspecified, at most 50 private connections that are returned.
The maximum value is 1000; values above 1000 are coerced to 1000.
Returns
(::Integer) — Maximum number of private connections to return.
If unspecified, at most 50 private connections that are returned.
The maximum value is 1000; values above 1000 are coerced to 1000.
#page_token
defpage_token()->::String
Returns
(::String) — Page token received from a previous ListPrivateConnections call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
ListPrivateConnections must match the call that provided the page
token.
#page_token=
defpage_token=(value)->::String
Parameter
value (::String) — Page token received from a previous ListPrivateConnections call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
ListPrivateConnections must match the call that provided the page
token.
Returns
(::String) — Page token received from a previous ListPrivateConnections call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
ListPrivateConnections must match the call that provided the page
token.
#parent
defparent()->::String
Returns
(::String) — Required. The parent that owns the collection of private connections.
#parent=
defparent=(value)->::String
Parameter
value (::String) — Required. The parent that owns the collection of private connections.
Returns
(::String) — Required. The parent that owns the collection of private connections.
[[["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-09-09 UTC."],[],[],null,["# Cloud Database Migration Service V1 API - Class Google::Cloud::CloudDMS::V1::ListPrivateConnectionsRequest (v1.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.1 (latest)](/ruby/docs/reference/google-cloud-cloud_dms-v1/latest/Google-Cloud-CloudDMS-V1-ListPrivateConnectionsRequest)\n- [1.3.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/1.3.0/Google-Cloud-CloudDMS-V1-ListPrivateConnectionsRequest)\n- [1.2.2](/ruby/docs/reference/google-cloud-cloud_dms-v1/1.2.2/Google-Cloud-CloudDMS-V1-ListPrivateConnectionsRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/1.1.0/Google-Cloud-CloudDMS-V1-ListPrivateConnectionsRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-cloud_dms-v1/1.0.1/Google-Cloud-CloudDMS-V1-ListPrivateConnectionsRequest)\n- [0.8.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.8.0/Google-Cloud-CloudDMS-V1-ListPrivateConnectionsRequest)\n- [0.7.2](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.7.2/Google-Cloud-CloudDMS-V1-ListPrivateConnectionsRequest)\n- [0.6.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.6.0/Google-Cloud-CloudDMS-V1-ListPrivateConnectionsRequest)\n- [0.5.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.5.0/Google-Cloud-CloudDMS-V1-ListPrivateConnectionsRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.4.0/Google-Cloud-CloudDMS-V1-ListPrivateConnectionsRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.3.0/Google-Cloud-CloudDMS-V1-ListPrivateConnectionsRequest)\n- [0.2.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.2.0/Google-Cloud-CloudDMS-V1-ListPrivateConnectionsRequest)\n- [0.1.5](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.1.5/Google-Cloud-CloudDMS-V1-ListPrivateConnectionsRequest) \nReference documentation and code samples for the Cloud Database Migration Service V1 API class Google::Cloud::CloudDMS::V1::ListPrivateConnectionsRequest.\n\nRequest message to retrieve a list of private connections in a given project\nand location. \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) --- A filter expression that filters private connections 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 either =, !=, \\\u003e, or \\\u003c. For example, list private connections created this year by specifying **createTime %gt; 2021-01-01T00:00:00.000000000Z**.\n\n### #filter=\n\n def filter=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A filter expression that filters private connections 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 either =, !=, \\\u003e, or \\\u003c. For example, list private connections created this year by specifying **createTime %gt; 2021-01-01T00:00:00.000000000Z**. \n**Returns**\n\n- (::String) --- A filter expression that filters private connections 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 either =, !=, \\\u003e, or \\\u003c. For example, list private connections created this year by specifying **createTime %gt; 2021-01-01T00:00:00.000000000Z**.\n\n### #order_by\n\n def order_by() -\u003e ::String\n\n**Returns**\n\n- (::String) --- 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) --- Order by fields for the result. \n**Returns**\n\n- (::String) --- Order by fields for the result.\n\n### #page_size\n\n def page_size() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- Maximum number of private connections to return. If unspecified, at most 50 private connections that are returned. The maximum value is 1000; values above 1000 are coerced to 1000.\n\n### #page_size=\n\n def page_size=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- Maximum number of private connections to return. If unspecified, at most 50 private connections that are returned. The maximum value is 1000; values above 1000 are coerced to 1000. \n**Returns**\n\n- (::Integer) --- Maximum number of private connections to return. If unspecified, at most 50 private connections that are returned. The maximum value is 1000; values above 1000 are coerced to 1000.\n\n### #page_token\n\n def page_token() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Page token received from a previous `ListPrivateConnections` call. Provide this to retrieve the subsequent page.\n\n\n When paginating, all other parameters provided to\n `ListPrivateConnections` must match the call that provided the page\n token.\n\n### #page_token=\n\n def page_token=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Page token received from a previous `ListPrivateConnections` call. Provide this to retrieve the subsequent page.\n\n\n When paginating, all other parameters provided to\n `ListPrivateConnections` must match the call that provided the page\ntoken. \n**Returns**\n\n- (::String) --- Page token received from a previous `ListPrivateConnections` call. Provide this to retrieve the subsequent page.\n\n\n When paginating, all other parameters provided to\n `ListPrivateConnections` must match the call that provided the page\n token.\n\n### #parent\n\n def parent() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The parent that owns the collection of private connections.\n\n### #parent=\n\n def parent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The parent that owns the collection of private connections. \n**Returns**\n\n- (::String) --- Required. The parent that owns the collection of private connections."]]