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

Methods

__construct

Constructor.

Parameters
Name
Description
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 will be returned. The maximum value is 1000; values above 1000 will be 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}

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
Type
Description
string

setParent

Required. The resource name of the TensorboardExperiment to list TensorboardRuns.

Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFilter

Lists the TensorboardRuns that match the filter expression.

Generated from protobuf field string filter = 2;

Returns
Type
Description
string

setFilter

Lists the TensorboardRuns that match the filter expression.

Generated from protobuf field string filter = 2;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPageSize

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

Generated from protobuf field int32 page_size = 3;

Returns
Type
Description
int

setPageSize

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

Generated from protobuf field int32 page_size = 3;

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

Generated from protobuf field string page_token = 4;

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

Generated from protobuf field string page_token = 4;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getOrderBy

Field to use to sort the list.

Generated from protobuf field string order_by = 5;

Returns
Type
Description
string

setOrderBy

Field to use to sort the list.

Generated from protobuf field string order_by = 5;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getReadMask

Mask specifying which fields to read.

Generated from protobuf field .google.protobuf.FieldMask read_mask = 6;

Returns
Type
Description
Google\Protobuf\FieldMask|null

hasReadMask

clearReadMask

setReadMask

Mask specifying which fields to read.

Generated from protobuf field .google.protobuf.FieldMask read_mask = 6;

Parameter
Name
Description
var
Google\Protobuf\FieldMask
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: