Google Cloud Ai Platform V1 Client - Class ListTensorboardRunsRequest (0.31.0)

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

Request message for TensorboardService.ListTensorboardRuns.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

↳ filter string

Lists the TensorboardRuns that match the filter expression.

↳ page_size int

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

↳ page_token string

A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns 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 TensorboardExperiment to list TensorboardRuns. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

Returns
TypeDescription
string

setParent

Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Lists the TensorboardRuns that match the filter expression.

Returns
TypeDescription
string

setFilter

Lists the TensorboardRuns that match the filter expression.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

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

Returns
TypeDescription
int

setPageSize

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

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

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

Returns
TypeDescription
string

setPageToken

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

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOrderBy

Field to use to sort the list.

Returns
TypeDescription
string

setOrderBy

Field to use to sort the list.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReadMask

Mask specifying which fields to read.

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasReadMask

clearReadMask

setReadMask

Mask specifying which fields to read.

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parent string

Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} Please see Google\Cloud\AIPlatform\V1\TensorboardServiceClient::tensorboardExperimentName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\ListTensorboardRunsRequest