Google Cloud Hypercompute Cluster V1beta Client - Class ListClustersRequest (0.1.0)

Reference documentation and code samples for the Google Cloud Hypercompute Cluster V1beta Client class ListClustersRequest.

Request message for ListClusters.

Generated from protobuf message google.cloud.hypercomputecluster.v1beta.ListClustersRequest

Namespace

Google \ Cloud \ HypercomputeCluster \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. Parent location of the clusters to list, in the format projects/{project}/locations/{location}.
↳ page_size int

Optional. Maximum number of clusters to return. The service may return fewer than this value.
↳ page_token string

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.
↳ filter string

Optional. Filter to apply to the returned results.
↳ order_by string

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.

getParent

Required. Parent location of the clusters to list, in the format projects/{project}/locations/{location}.

Returns
Type Description
string

setParent

Required. Parent location of the clusters to list, in the format projects/{project}/locations/{location}.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. Maximum number of clusters to return. The service may return fewer than this value.

Returns
Type Description
int

setPageSize

Optional. Maximum number of clusters to return. The service may return fewer than this value.

Parameter
Name Description
var int
Returns
Type Description
$this

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.

Returns
Type Description
string

setPageToken

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. Filter to apply to the returned results.

Returns
Type Description
string

setFilter

Optional. Filter to apply to the returned results.

Parameter
Name Description
var string
Returns
Type Description
$this

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.
Returns
Type Description
string

setOrderBy

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.
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. Parent location of the clusters to list, in the format projects/{project}/locations/{location}. Please see HypercomputeClusterClient::locationName() for help formatting this field.
Returns
Type Description
ListClustersRequest