Cloud SQL Admin V1 API - Class Google::Cloud::Sql::V1::SqlInstancesListRequest (v0.1.0)

Reference documentation and code samples for the Cloud SQL Admin V1 API class Google::Cloud::Sql::V1::SqlInstancesListRequest.

Instance list request.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) — A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'.

    Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'.

    Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.

Returns
  • (::String) — A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'.

    Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.

#max_results

def max_results() -> ::Integer
Returns
  • (::Integer) — The maximum number of instances to return. The service may return fewer than this value. If unspecified, at most 500 instances are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

#max_results=

def max_results=(value) -> ::Integer
Parameter
  • value (::Integer) — The maximum number of instances to return. The service may return fewer than this value. If unspecified, at most 500 instances are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
Returns
  • (::Integer) — The maximum number of instances to return. The service may return fewer than this value. If unspecified, at most 500 instances are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

#page_token

def page_token() -> ::String
Returns
  • (::String) — A previously-returned page token representing part of the larger set of results to view.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — A previously-returned page token representing part of the larger set of results to view.
Returns
  • (::String) — A previously-returned page token representing part of the larger set of results to view.

#project

def project() -> ::String
Returns
  • (::String) — Project ID of the project for which to list Cloud SQL instances.

#project=

def project=(value) -> ::String
Parameter
  • value (::String) — Project ID of the project for which to list Cloud SQL instances.
Returns
  • (::String) — Project ID of the project for which to list Cloud SQL instances.