Package com.google.cloud.hypercomputecluster.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()
    Optional.
    com.google.protobuf.ByteString
    getFilterBytes()
    Optional.
    String
    getOrderBy()
    Optional.
    com.google.protobuf.ByteString
    getOrderByBytes()
    Optional.
    int
    getPageSize()
    Optional.
    String
    getPageToken()
    Optional.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Optional.
    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. Parent location of the clusters to list, in the format
 `projects/{project}/locations/{location}`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. Parent location of the clusters to list, in the format
 `projects/{project}/locations/{location}`.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getPageSize

      int getPageSize()
       Optional. Maximum number of clusters to return. The service may return
 fewer than this value.
      int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.

    • getFilter

      String getFilter()
       Optional. [Filter](https://google.aip.dev/160) to apply to the returned
 results.
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Optional. [Filter](https://google.aip.dev/160) to apply to the returned
 results.
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for filter.

    • getOrderBy

      String getOrderBy()
       Optional. How to order the resulting clusters. Must be one of the following
 strings:

 * `name`
 * `name desc`
 * `create_time`
 * `create_time desc`

 If not specified, clusters will be returned in an arbitrary order.
      string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The orderBy.

    • getOrderByBytes

      com.google.protobuf.ByteString getOrderByBytes()
       Optional. How to order the resulting clusters. Must be one of the following
 strings:

 * `name`
 * `name desc`
 * `create_time`
 * `create_time desc`

 If not specified, clusters will be returned in an arbitrary order.
      string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for orderBy.