Package com.google.cloud.vmwareengine.v1

Interface ListClustersRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListClustersRequest, ListClustersRequest.Builder
@Generated public interface ListClustersRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    To filter on multiple expressions, provide each separate expression within parentheses.
    com.google.protobuf.ByteString
    getFilterBytes()
    To filter on multiple expressions, provide each separate expression within parentheses.
    String
    getOrderBy()
    Sorts list results by a certain order.
    com.google.protobuf.ByteString
    getOrderByBytes()
    Sorts list results by a certain order.
    int
    getPageSize()
    The maximum number of clusters to return in one page.
    String
    getPageToken()
    A page token, received from a previous `ListClusters` call.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    A page token, received from a previous `ListClusters` call.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getParent

      String getParent()
       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`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       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`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getPageSize

      int getPageSize()
       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.
      int32 page_size = 2;
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       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.
      string page_token = 3;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       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.
      string page_token = 3;
      Returns:
      The bytes for pageToken.

    • getFilter

      String getFilter()
      
 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")
 ```
      string filter = 4;
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
      
 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")
 ```
      string filter = 4;
      Returns:
      The bytes for filter.

    • getOrderBy

      String getOrderBy()
       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.
      string order_by = 5;
      Returns:
      The orderBy.

    • getOrderByBytes

      com.google.protobuf.ByteString getOrderByBytes()
       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.
      string order_by = 5;
      Returns:
      The bytes for orderBy.