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

Methods

build

Parameters
Name	Description
`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 {@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
Type	Description
`Google\Cloud\AIPlatform\V1\CreateTensorboardRunRequest`

__construct

Constructor.

Parameters
Name	Description
`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
Type	Description
`string`

setParent

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTensorboardRun

Required. The TensorboardRun to create.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\TensorboardRun\|null`

hasTensorboardRun

clearTensorboardRun

setTensorboardRun

Required. The TensorboardRun to create.

Parameter
Name	Description
`var`	`Google\Cloud\AIPlatform\V1\TensorboardRun`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`string`

Returns
Type	Description
`$this`