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

Methods

__construct

Constructor.

Parameters
NameDescription
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 will become 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}

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 Tensorboard to create the TensorboardExperiment in. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTensorboardExperiment

The TensorboardExperiment to create.

Generated from protobuf field .google.cloud.aiplatform.v1.TensorboardExperiment tensorboard_experiment = 2;

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

hasTensorboardExperiment

clearTensorboardExperiment

setTensorboardExperiment

The TensorboardExperiment to create.

Generated from protobuf field .google.cloud.aiplatform.v1.TensorboardExperiment tensorboard_experiment = 2;

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

getTensorboardExperimentId

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

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

Returns
TypeDescription
string

setTensorboardExperimentId

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

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this