Reference documentation and code samples for the Google Cloud Notebooks V2 Client class ListInstancesRequest.
Request for listing notebook instances.
Generated from protobuf message google.cloud.notebooks.v2.ListInstancesRequest
Namespace
Google \ Cloud \ Notebooks \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. Format: |
↳ page_size |
int
Optional. Maximum return size of the list call. |
↳ page_token |
string
Optional. A previous returned page token that can be used to continue listing from the last result. |
↳ order_by |
string
Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted). |
↳ filter |
string
Optional. List filter. |
getParent
Required. Format:
parent=projects/{project_id}/locations/{location}
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. Format:
parent=projects/{project_id}/locations/{location}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Optional. Maximum return size of the list call.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Optional. Maximum return size of the list call.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
Optional. A previous returned page token that can be used to continue listing from the last result.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
Optional. A previous returned page token that can be used to continue listing from the last result.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrderBy
Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted).
| Returns | |
|---|---|
| Type | Description |
string | |
setOrderBy
Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
Optional. List filter.
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
Optional. List filter.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. Format:
|
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Notebooks\V2\ListInstancesRequest | |