Google Cloud Ai Platform V1 Client - Class CreateTensorboardRunRequest (0.25.0)

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

Request message for TensorboardService.CreateTensorboardRun.

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

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 TensorboardRun in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}

↳ tensorboard_run Google\Cloud\AIPlatform\V1\TensorboardRun

Required. The TensorboardRun to create.

↳ tensorboard_run_id string

Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /[a-z][0-9]-/.

getParent

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

Returns
TypeDescription
string

setParent

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTensorboardRun

Required. The TensorboardRun to create.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\TensorboardRun|null

hasTensorboardRun

clearTensorboardRun

setTensorboardRun

Required. The TensorboardRun to create.

Parameter
NameDescription
var Google\Cloud\AIPlatform\V1\TensorboardRun
Returns
TypeDescription
$this

getTensorboardRunId

Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name.

This value should be 1-128 characters, and valid characters are /[a-z][0-9]-/.

Returns
TypeDescription
string

setTensorboardRunId

Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name.

This value should be 1-128 characters, and valid characters are /[a-z][0-9]-/.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parent string

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

tensorboardRun Google\Cloud\AIPlatform\V1\TensorboardRun

Required. The TensorboardRun to create.

tensorboardRunId string

Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name.

This value should be 1-128 characters, and valid characters are /[a-z][0-9]-/.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\CreateTensorboardRunRequest