Google Cloud Ai Platform V1 Client - Class BatchCreateTensorboardRunsRequest (0.28.0)

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

Request message for TensorboardService.BatchCreateTensorboardRuns.

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

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 create the TensorboardRuns in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} The parent field in the CreateTensorboardRunRequest messages must match this field.

↳ requests array<Google\Cloud\AIPlatform\V1\CreateTensorboardRunRequest>

Required. The request message specifying the TensorboardRuns to create. A maximum of 1000 TensorboardRuns can be created in a batch.

getParent

Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} The parent field in the CreateTensorboardRunRequest messages must match this field.

Returns
TypeDescription
string

setParent

Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment} The parent field in the CreateTensorboardRunRequest messages must match this field.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRequests

Required. The request message specifying the TensorboardRuns to create.

A maximum of 1000 TensorboardRuns can be created in a batch.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setRequests

Required. The request message specifying the TensorboardRuns to create.

A maximum of 1000 TensorboardRuns can be created in a batch.

Parameter
NameDescription
var array<Google\Cloud\AIPlatform\V1\CreateTensorboardRunRequest>
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parent string

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

requests array<Google\Cloud\AIPlatform\V1\CreateTensorboardRunRequest>

Required. The request message specifying the TensorboardRuns to create. A maximum of 1000 TensorboardRuns can be created in a batch.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\BatchCreateTensorboardRunsRequest