Class: Google::Cloud::VmwareEngine::V1::ListClustersRequest

Inherits:

Object

• Object
• Google::Cloud::VmwareEngine::V1::ListClustersRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/vmwareengine/v1/vmwareengine.rb

Overview

Request message for VmwareEngine.ListClusters

Instance Attribute Summary

• #filter ⇒ ::String

  To filter on multiple expressions, provide each separate expression within parentheses.

• #order_by ⇒ ::String

  Sorts list results by a certain order.

• #page_size ⇒ ::Integer

  The maximum number of clusters to return in one page.

• #page_token ⇒ ::String

  A page token, received from a previous ListClusters call.

• #parent ⇒ ::String

  Required.

Instance Attribute Details

#filter ⇒ ::String

Returns To filter on multiple expressions, provide each separate expression within parentheses. For example:

(name = "example-cluster")
(nodeCount = "3")

By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example:

(name = "example-cluster-1") AND
(createTime > "2021-04-12T08:15:10.40Z") OR
(name = "example-cluster-2")
```.

Returns:

• (::String) —

  To filter on multiple expressions, provide each separate expression within parentheses. For example:

  (name = "example-cluster")
  (nodeCount = "3")
  

  By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example:

  (name = "example-cluster-1") AND
  (createTime > "2021-04-12T08:15:10.40Z") OR
  (name = "example-cluster-2")
  

# File 'proto_docs/google/cloud/vmwareengine/v1/vmwareengine.rb', line 274

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

#order_by ⇒ ::String

Returns Sorts list results by a certain order. By default, returned results are ordered by name in ascending order. You can also sort results in descending order based on the name value using orderBy="name desc". Currently, only ordering by name is supported.

Returns:

• (::String) —

  Sorts list results by a certain order. By default, returned results are ordered by name in ascending order. You can also sort results in descending order based on the name value using orderBy="name desc". Currently, only ordering by name is supported.

# File 'proto_docs/google/cloud/vmwareengine/v1/vmwareengine.rb', line 274

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

#page_size ⇒ ::Integer

Returns The maximum number of clusters to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.

Returns:

• (::Integer) —

  The maximum number of clusters to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.

# File 'proto_docs/google/cloud/vmwareengine/v1/vmwareengine.rb', line 274

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

#page_token ⇒ ::String

Returns A page token, received from a previous ListClusters call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListClusters must match the call that provided the page token.

Returns:

• (::String) —

  A page token, received from a previous ListClusters call. Provide this to retrieve the subsequent page.

  When paginating, all other parameters provided to ListClusters must match the call that provided the page token.

# File 'proto_docs/google/cloud/vmwareengine/v1/vmwareengine.rb', line 274

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

#parent ⇒ ::String

Returns Required. The resource name of the private cloud to query for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud.

Returns:

• (::String) —

  Required. The resource name of the private cloud to query for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud

# File 'proto_docs/google/cloud/vmwareengine/v1/vmwareengine.rb', line 274

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