Google Cloud Ai Platform V1 Client - Class ListTensorboardsRequest (1.11.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