Google Cloud Ai Platform V1 Client - Class ListTensorboardsRequest (1.11.0)

Version 1.11.0

• 1.13.1 (latest)
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListTensorboardsRequest.

Request message for TensorboardService.ListTensorboards.

Generated from protobuf message google.cloud.aiplatform.v1.ListTensorboardsRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The resource name of the Location to list Tensorboards. Format: projects/{project}/locations/{location}
↳ filter	string Lists the Tensorboards that match the filter expression.
↳ page_size	int The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.
↳ page_token	string A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token.
↳ order_by	string Field to use to sort the list.
↳ read_mask	Google\Protobuf\FieldMask Mask specifying which fields to read.

getParent

Required. The resource name of the Location to list Tensorboards.

Format: projects/{project}/locations/{location}

Returns
Type	Description
string

setParent

Required. The resource name of the Location to list Tensorboards.

Format: projects/{project}/locations/{location}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFilter

Lists the Tensorboards that match the filter expression.

Returns
Type	Description
string

setFilter

Lists the Tensorboards that match the filter expression.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.

Returns
Type	Description
int

setPageSize

The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

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

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

Returns
Type	Description
string

setPageToken

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

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getOrderBy

Field to use to sort the list.

Returns
Type	Description
string

setOrderBy

Field to use to sort the list.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getReadMask

Mask specifying which fields to read.

Returns
Type	Description
Google\Protobuf\FieldMask|null

hasReadMask

clearReadMask

setReadMask

Mask specifying which fields to read.

Parameter
Name	Description
var	Google\Protobuf\FieldMask

Returns
Type	Description
$this

static::build

Parameter
Name	Description
parent	string Required. The resource name of the Location to list Tensorboards. Format: projects/{project}/locations/{location} Please see Google\Cloud\AIPlatform\V1\TensorboardServiceClient::locationName() for help formatting this field.

Returns
Type	Description
Google\Cloud\AIPlatform\V1\ListTensorboardsRequest