Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::UpdateTensorboardRunRequest (v0.2.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::UpdateTensorboardRunRequest.

Request message for TensorboardService.UpdateTensorboardRun.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#tensorboard_run

def tensorboard_run() -> ::Google::Cloud::AIPlatform::V1::TensorboardRun
Returns
  • (::Google::Cloud::AIPlatform::V1::TensorboardRun) — Required. The TensorboardRun's name field is used to identify the TensorboardRun to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

#tensorboard_run=

def tensorboard_run=(value) -> ::Google::Cloud::AIPlatform::V1::TensorboardRun
Parameter
  • value (::Google::Cloud::AIPlatform::V1::TensorboardRun) — Required. The TensorboardRun's name field is used to identify the TensorboardRun to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}
Returns
  • (::Google::Cloud::AIPlatform::V1::TensorboardRun) — Required. The TensorboardRun's name field is used to identify the TensorboardRun to be updated. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}

#update_mask

def update_mask() -> ::Google::Protobuf::FieldMask
Returns
  • (::Google::Protobuf::FieldMask) — Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten if new values are specified.

#update_mask=

def update_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
  • value (::Google::Protobuf::FieldMask) — Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten if new values are specified.
Returns
  • (::Google::Protobuf::FieldMask) — Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten if new values are specified.