Google Cloud Ai Platform V1 Client - Class CreateTensorboardExperimentRequest (0.18.0)

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

Request message for TensorboardService.CreateTensorboardExperiment.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
`↳ tensorboard_experiment`	`Google\Cloud\AIPlatform\V1\TensorboardExperiment` The TensorboardExperiment to create.
`↳ tensorboard_experiment_id`	`string` Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment'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 Tensorboard to create the TensorboardExperiment in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

Returns
Type	Description
`string`

setParent

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTensorboardExperiment

The TensorboardExperiment to create.

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

hasTensorboardExperiment

clearTensorboardExperiment

setTensorboardExperiment

The TensorboardExperiment to create.

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

Returns
Type	Description
`$this`

getTensorboardExperimentId

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

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

Returns
Type	Description
`string`

setTensorboardExperimentId

Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment'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`

static::build

Parameters
Name	Description
`parent`	`string` Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}` Please see Google\Cloud\AIPlatform\V1\TensorboardServiceClient::tensorboardExperimentName() for help formatting this field.
`tensorboardExperiment`	`Google\Cloud\AIPlatform\V1\TensorboardExperiment` The TensorboardExperiment to create.
`tensorboardExperimentId`	`string` Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment'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\CreateTensorboardExperimentRequest`