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

__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 will become 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}

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

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}

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTensorboardRun

Required. The TensorboardRun to create.

Generated from protobuf field .google.cloud.aiplatform.v1.TensorboardRun tensorboard_run = 2 [(.google.api.field_behavior) = REQUIRED];

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

hasTensorboardRun

clearTensorboardRun

setTensorboardRun

Required. The TensorboardRun to create.

Generated from protobuf field .google.cloud.aiplatform.v1.TensorboardRun tensorboard_run = 2 [(.google.api.field_behavior) = REQUIRED];

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

getTensorboardRunId

Required. The ID to use for the Tensorboard run, which will become 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]-/.

Generated from protobuf field string tensorboard_run_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
string

setTensorboardRunId

Required. The ID to use for the Tensorboard run, which will become 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]-/.

Generated from protobuf field string tensorboard_run_id = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var string
Returns
TypeDescription
$this