cloud.google.com/go/aiplatform@v1.106.0/apiv1/aiplatformpb/tensorboard_run.pb.go (about)

     1  // Copyright 2025 Google LLC
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Code generated by protoc-gen-go. DO NOT EDIT.
    16  // versions:
    17  // 	protoc-gen-go v1.35.2
    18  // 	protoc        v4.25.7
    19  // source: google/cloud/aiplatform/v1/tensorboard_run.proto
    20  
    21  package aiplatformpb
    22  
    23  import (
    24  	_ "google.golang.org/genproto/googleapis/api/annotations"
    25  	protoreflect "google.golang.org/protobuf/reflect/protoreflect"
    26  	protoimpl "google.golang.org/protobuf/runtime/protoimpl"
    27  	timestamppb "google.golang.org/protobuf/types/known/timestamppb"
    28  	reflect "reflect"
    29  	sync "sync"
    30  )
    31  
    32  const (
    33  	// Verify that this generated code is sufficiently up-to-date.
    34  	_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
    35  	// Verify that runtime/protoimpl is sufficiently up-to-date.
    36  	_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
    37  )
    38  
    39  // TensorboardRun maps to a specific execution of a training job with a given
    40  // set of hyperparameter values, model definition, dataset, etc
    41  type TensorboardRun struct {
    42  	state         protoimpl.MessageState
    43  	sizeCache     protoimpl.SizeCache
    44  	unknownFields protoimpl.UnknownFields
    45  
    46  	// Output only. Name of the TensorboardRun.
    47  	// Format:
    48  	// `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`
    49  	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    50  	// Required. User provided name of this TensorboardRun.
    51  	// This value must be unique among all TensorboardRuns
    52  	// belonging to the same parent TensorboardExperiment.
    53  	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
    54  	// Description of this TensorboardRun.
    55  	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
    56  	// Output only. Timestamp when this TensorboardRun was created.
    57  	CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
    58  	// Output only. Timestamp when this TensorboardRun was last updated.
    59  	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
    60  	// The labels with user-defined metadata to organize your TensorboardRuns.
    61  	//
    62  	// This field will be used to filter and visualize Runs in the Tensorboard UI.
    63  	// For example, a Vertex AI training job can set a label
    64  	// aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created
    65  	// within that job. An end user can set a label experiment_id=xxxxx for all
    66  	// the runs produced in a Jupyter notebook. These runs can be grouped by a
    67  	// label value and visualized together in the Tensorboard UI.
    68  	//
    69  	// Label keys and values can be no longer than 64 characters
    70  	// (Unicode codepoints), can only contain lowercase letters, numeric
    71  	// characters, underscores and dashes. International characters are allowed.
    72  	// No more than 64 user labels can be associated with one TensorboardRun
    73  	// (System labels are excluded).
    74  	//
    75  	// See https://goo.gl/xmQnxf for more information and examples of labels.
    76  	// System reserved label keys are prefixed with "aiplatform.googleapis.com/"
    77  	// and are immutable.
    78  	Labels map[string]string `protobuf:"bytes,8,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    79  	// Used to perform a consistent read-modify-write updates. If not set, a blind
    80  	// "overwrite" update happens.
    81  	Etag string `protobuf:"bytes,9,opt,name=etag,proto3" json:"etag,omitempty"`
    82  }
    83  
    84  func (x *TensorboardRun) Reset() {
    85  	*x = TensorboardRun{}
    86  	mi := &file_google_cloud_aiplatform_v1_tensorboard_run_proto_msgTypes[0]
    87  	ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
    88  	ms.StoreMessageInfo(mi)
    89  }
    90  
    91  func (x *TensorboardRun) String() string {
    92  	return protoimpl.X.MessageStringOf(x)
    93  }
    94  
    95  func (*TensorboardRun) ProtoMessage() {}
    96  
    97  func (x *TensorboardRun) ProtoReflect() protoreflect.Message {
    98  	mi := &file_google_cloud_aiplatform_v1_tensorboard_run_proto_msgTypes[0]
    99  	if x != nil {
   100  		ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
   101  		if ms.LoadMessageInfo() == nil {
   102  			ms.StoreMessageInfo(mi)
   103  		}
   104  		return ms
   105  	}
   106  	return mi.MessageOf(x)
   107  }
   108  
   109  // Deprecated: Use TensorboardRun.ProtoReflect.Descriptor instead.
   110  func (*TensorboardRun) Descriptor() ([]byte, []int) {
   111  	return file_google_cloud_aiplatform_v1_tensorboard_run_proto_rawDescGZIP(), []int{0}
   112  }
   113  
   114  func (x *TensorboardRun) GetName() string {
   115  	if x != nil {
   116  		return x.Name
   117  	}
   118  	return ""
   119  }
   120  
   121  func (x *TensorboardRun) GetDisplayName() string {
   122  	if x != nil {
   123  		return x.DisplayName
   124  	}
   125  	return ""
   126  }
   127  
   128  func (x *TensorboardRun) GetDescription() string {
   129  	if x != nil {
   130  		return x.Description
   131  	}
   132  	return ""
   133  }
   134  
   135  func (x *TensorboardRun) GetCreateTime() *timestamppb.Timestamp {
   136  	if x != nil {
   137  		return x.CreateTime
   138  	}
   139  	return nil
   140  }
   141  
   142  func (x *TensorboardRun) GetUpdateTime() *timestamppb.Timestamp {
   143  	if x != nil {
   144  		return x.UpdateTime
   145  	}
   146  	return nil
   147  }
   148  
   149  func (x *TensorboardRun) GetLabels() map[string]string {
   150  	if x != nil {
   151  		return x.Labels
   152  	}
   153  	return nil
   154  }
   155  
   156  func (x *TensorboardRun) GetEtag() string {
   157  	if x != nil {
   158  		return x.Etag
   159  	}
   160  	return ""
   161  }
   162  
   163  var File_google_cloud_aiplatform_v1_tensorboard_run_proto protoreflect.FileDescriptor
   164  
   165  var file_google_cloud_aiplatform_v1_tensorboard_run_proto_rawDesc = []byte{
   166  	0x0a, 0x30, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2f, 0x63, 0x6c, 0x6f, 0x75, 0x64, 0x2f, 0x61,
   167  	0x69, 0x70, 0x6c, 0x61, 0x74, 0x66, 0x6f, 0x72, 0x6d, 0x2f, 0x76, 0x31, 0x2f, 0x74, 0x65, 0x6e,
   168  	0x73, 0x6f, 0x72, 0x62, 0x6f, 0x61, 0x72, 0x64, 0x5f, 0x72, 0x75, 0x6e, 0x2e, 0x70, 0x72, 0x6f,
   169  	0x74, 0x6f, 0x12, 0x1a, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x63, 0x6c, 0x6f, 0x75, 0x64,
   170  	0x2e, 0x61, 0x69, 0x70, 0x6c, 0x61, 0x74, 0x66, 0x6f, 0x72, 0x6d, 0x2e, 0x76, 0x31, 0x1a, 0x1f,
   171  	0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2f, 0x61, 0x70, 0x69, 0x2f, 0x66, 0x69, 0x65, 0x6c, 0x64,
   172  	0x5f, 0x62, 0x65, 0x68, 0x61, 0x76, 0x69, 0x6f, 0x72, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x1a,
   173  	0x19, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2f, 0x61, 0x70, 0x69, 0x2f, 0x72, 0x65, 0x73, 0x6f,
   174  	0x75, 0x72, 0x63, 0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x1a, 0x1f, 0x67, 0x6f, 0x6f, 0x67,
   175  	0x6c, 0x65, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2f, 0x74, 0x69, 0x6d, 0x65,
   176  	0x73, 0x74, 0x61, 0x6d, 0x70, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x22, 0xaf, 0x04, 0x0a, 0x0e,
   177  	0x54, 0x65, 0x6e, 0x73, 0x6f, 0x72, 0x62, 0x6f, 0x61, 0x72, 0x64, 0x52, 0x75, 0x6e, 0x12, 0x17,
   178  	0x0a, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x42, 0x03, 0xe0, 0x41,
   179  	0x03, 0x52, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x12, 0x26, 0x0a, 0x0c, 0x64, 0x69, 0x73, 0x70, 0x6c,
   180  	0x61, 0x79, 0x5f, 0x6e, 0x61, 0x6d, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x09, 0x42, 0x03, 0xe0,
   181  	0x41, 0x02, 0x52, 0x0b, 0x64, 0x69, 0x73, 0x70, 0x6c, 0x61, 0x79, 0x4e, 0x61, 0x6d, 0x65, 0x12,
   182  	0x20, 0x0a, 0x0b, 0x64, 0x65, 0x73, 0x63, 0x72, 0x69, 0x70, 0x74, 0x69, 0x6f, 0x6e, 0x18, 0x03,
   183  	0x20, 0x01, 0x28, 0x09, 0x52, 0x0b, 0x64, 0x65, 0x73, 0x63, 0x72, 0x69, 0x70, 0x74, 0x69, 0x6f,
   184  	0x6e, 0x12, 0x40, 0x0a, 0x0b, 0x63, 0x72, 0x65, 0x61, 0x74, 0x65, 0x5f, 0x74, 0x69, 0x6d, 0x65,
   185  	0x18, 0x06, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x1a, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e,
   186  	0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x54, 0x69, 0x6d, 0x65, 0x73, 0x74, 0x61,
   187  	0x6d, 0x70, 0x42, 0x03, 0xe0, 0x41, 0x03, 0x52, 0x0a, 0x63, 0x72, 0x65, 0x61, 0x74, 0x65, 0x54,
   188  	0x69, 0x6d, 0x65, 0x12, 0x40, 0x0a, 0x0b, 0x75, 0x70, 0x64, 0x61, 0x74, 0x65, 0x5f, 0x74, 0x69,
   189  	0x6d, 0x65, 0x18, 0x07, 0x20, 0x01, 0x28, 0x0b, 0x32, 0x1a, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c,
   190  	0x65, 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x62, 0x75, 0x66, 0x2e, 0x54, 0x69, 0x6d, 0x65, 0x73,
   191  	0x74, 0x61, 0x6d, 0x70, 0x42, 0x03, 0xe0, 0x41, 0x03, 0x52, 0x0a, 0x75, 0x70, 0x64, 0x61, 0x74,
   192  	0x65, 0x54, 0x69, 0x6d, 0x65, 0x12, 0x4e, 0x0a, 0x06, 0x6c, 0x61, 0x62, 0x65, 0x6c, 0x73, 0x18,
   193  	0x08, 0x20, 0x03, 0x28, 0x0b, 0x32, 0x36, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x63,
   194  	0x6c, 0x6f, 0x75, 0x64, 0x2e, 0x61, 0x69, 0x70, 0x6c, 0x61, 0x74, 0x66, 0x6f, 0x72, 0x6d, 0x2e,
   195  	0x76, 0x31, 0x2e, 0x54, 0x65, 0x6e, 0x73, 0x6f, 0x72, 0x62, 0x6f, 0x61, 0x72, 0x64, 0x52, 0x75,
   196  	0x6e, 0x2e, 0x4c, 0x61, 0x62, 0x65, 0x6c, 0x73, 0x45, 0x6e, 0x74, 0x72, 0x79, 0x52, 0x06, 0x6c,
   197  	0x61, 0x62, 0x65, 0x6c, 0x73, 0x12, 0x12, 0x0a, 0x04, 0x65, 0x74, 0x61, 0x67, 0x18, 0x09, 0x20,
   198  	0x01, 0x28, 0x09, 0x52, 0x04, 0x65, 0x74, 0x61, 0x67, 0x1a, 0x39, 0x0a, 0x0b, 0x4c, 0x61, 0x62,
   199  	0x65, 0x6c, 0x73, 0x45, 0x6e, 0x74, 0x72, 0x79, 0x12, 0x10, 0x0a, 0x03, 0x6b, 0x65, 0x79, 0x18,
   200  	0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x03, 0x6b, 0x65, 0x79, 0x12, 0x14, 0x0a, 0x05, 0x76, 0x61,
   201  	0x6c, 0x75, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x09, 0x52, 0x05, 0x76, 0x61, 0x6c, 0x75, 0x65,
   202  	0x3a, 0x02, 0x38, 0x01, 0x3a, 0x96, 0x01, 0xea, 0x41, 0x92, 0x01, 0x0a, 0x28, 0x61, 0x69, 0x70,
   203  	0x6c, 0x61, 0x74, 0x66, 0x6f, 0x72, 0x6d, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x61, 0x70,
   204  	0x69, 0x73, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x54, 0x65, 0x6e, 0x73, 0x6f, 0x72, 0x62, 0x6f, 0x61,
   205  	0x72, 0x64, 0x52, 0x75, 0x6e, 0x12, 0x66, 0x70, 0x72, 0x6f, 0x6a, 0x65, 0x63, 0x74, 0x73, 0x2f,
   206  	0x7b, 0x70, 0x72, 0x6f, 0x6a, 0x65, 0x63, 0x74, 0x7d, 0x2f, 0x6c, 0x6f, 0x63, 0x61, 0x74, 0x69,
   207  	0x6f, 0x6e, 0x73, 0x2f, 0x7b, 0x6c, 0x6f, 0x63, 0x61, 0x74, 0x69, 0x6f, 0x6e, 0x7d, 0x2f, 0x74,
   208  	0x65, 0x6e, 0x73, 0x6f, 0x72, 0x62, 0x6f, 0x61, 0x72, 0x64, 0x73, 0x2f, 0x7b, 0x74, 0x65, 0x6e,
   209  	0x73, 0x6f, 0x72, 0x62, 0x6f, 0x61, 0x72, 0x64, 0x7d, 0x2f, 0x65, 0x78, 0x70, 0x65, 0x72, 0x69,
   210  	0x6d, 0x65, 0x6e, 0x74, 0x73, 0x2f, 0x7b, 0x65, 0x78, 0x70, 0x65, 0x72, 0x69, 0x6d, 0x65, 0x6e,
   211  	0x74, 0x7d, 0x2f, 0x72, 0x75, 0x6e, 0x73, 0x2f, 0x7b, 0x72, 0x75, 0x6e, 0x7d, 0x42, 0xd1, 0x01,
   212  	0x0a, 0x1e, 0x63, 0x6f, 0x6d, 0x2e, 0x67, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x63, 0x6c, 0x6f,
   213  	0x75, 0x64, 0x2e, 0x61, 0x69, 0x70, 0x6c, 0x61, 0x74, 0x66, 0x6f, 0x72, 0x6d, 0x2e, 0x76, 0x31,
   214  	0x42, 0x13, 0x54, 0x65, 0x6e, 0x73, 0x6f, 0x72, 0x62, 0x6f, 0x61, 0x72, 0x64, 0x52, 0x75, 0x6e,
   215  	0x50, 0x72, 0x6f, 0x74, 0x6f, 0x50, 0x01, 0x5a, 0x3e, 0x63, 0x6c, 0x6f, 0x75, 0x64, 0x2e, 0x67,
   216  	0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x67, 0x6f, 0x2f, 0x61, 0x69, 0x70,
   217  	0x6c, 0x61, 0x74, 0x66, 0x6f, 0x72, 0x6d, 0x2f, 0x61, 0x70, 0x69, 0x76, 0x31, 0x2f, 0x61, 0x69,
   218  	0x70, 0x6c, 0x61, 0x74, 0x66, 0x6f, 0x72, 0x6d, 0x70, 0x62, 0x3b, 0x61, 0x69, 0x70, 0x6c, 0x61,
   219  	0x74, 0x66, 0x6f, 0x72, 0x6d, 0x70, 0x62, 0xaa, 0x02, 0x1a, 0x47, 0x6f, 0x6f, 0x67, 0x6c, 0x65,
   220  	0x2e, 0x43, 0x6c, 0x6f, 0x75, 0x64, 0x2e, 0x41, 0x49, 0x50, 0x6c, 0x61, 0x74, 0x66, 0x6f, 0x72,
   221  	0x6d, 0x2e, 0x56, 0x31, 0xca, 0x02, 0x1a, 0x47, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x5c, 0x43, 0x6c,
   222  	0x6f, 0x75, 0x64, 0x5c, 0x41, 0x49, 0x50, 0x6c, 0x61, 0x74, 0x66, 0x6f, 0x72, 0x6d, 0x5c, 0x56,
   223  	0x31, 0xea, 0x02, 0x1d, 0x47, 0x6f, 0x6f, 0x67, 0x6c, 0x65, 0x3a, 0x3a, 0x43, 0x6c, 0x6f, 0x75,
   224  	0x64, 0x3a, 0x3a, 0x41, 0x49, 0x50, 0x6c, 0x61, 0x74, 0x66, 0x6f, 0x72, 0x6d, 0x3a, 0x3a, 0x56,
   225  	0x31, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33,
   226  }
   227  
   228  var (
   229  	file_google_cloud_aiplatform_v1_tensorboard_run_proto_rawDescOnce sync.Once
   230  	file_google_cloud_aiplatform_v1_tensorboard_run_proto_rawDescData = file_google_cloud_aiplatform_v1_tensorboard_run_proto_rawDesc
   231  )
   232  
   233  func file_google_cloud_aiplatform_v1_tensorboard_run_proto_rawDescGZIP() []byte {
   234  	file_google_cloud_aiplatform_v1_tensorboard_run_proto_rawDescOnce.Do(func() {
   235  		file_google_cloud_aiplatform_v1_tensorboard_run_proto_rawDescData = protoimpl.X.CompressGZIP(file_google_cloud_aiplatform_v1_tensorboard_run_proto_rawDescData)
   236  	})
   237  	return file_google_cloud_aiplatform_v1_tensorboard_run_proto_rawDescData
   238  }
   239  
   240  var file_google_cloud_aiplatform_v1_tensorboard_run_proto_msgTypes = make([]protoimpl.MessageInfo, 2)
   241  var file_google_cloud_aiplatform_v1_tensorboard_run_proto_goTypes = []any{
   242  	(*TensorboardRun)(nil),        // 0: google.cloud.aiplatform.v1.TensorboardRun
   243  	nil,                           // 1: google.cloud.aiplatform.v1.TensorboardRun.LabelsEntry
   244  	(*timestamppb.Timestamp)(nil), // 2: google.protobuf.Timestamp
   245  }
   246  var file_google_cloud_aiplatform_v1_tensorboard_run_proto_depIdxs = []int32{
   247  	2, // 0: google.cloud.aiplatform.v1.TensorboardRun.create_time:type_name -> google.protobuf.Timestamp
   248  	2, // 1: google.cloud.aiplatform.v1.TensorboardRun.update_time:type_name -> google.protobuf.Timestamp
   249  	1, // 2: google.cloud.aiplatform.v1.TensorboardRun.labels:type_name -> google.cloud.aiplatform.v1.TensorboardRun.LabelsEntry
   250  	3, // [3:3] is the sub-list for method output_type
   251  	3, // [3:3] is the sub-list for method input_type
   252  	3, // [3:3] is the sub-list for extension type_name
   253  	3, // [3:3] is the sub-list for extension extendee
   254  	0, // [0:3] is the sub-list for field type_name
   255  }
   256  
   257  func init() { file_google_cloud_aiplatform_v1_tensorboard_run_proto_init() }
   258  func file_google_cloud_aiplatform_v1_tensorboard_run_proto_init() {
   259  	if File_google_cloud_aiplatform_v1_tensorboard_run_proto != nil {
   260  		return
   261  	}
   262  	type x struct{}
   263  	out := protoimpl.TypeBuilder{
   264  		File: protoimpl.DescBuilder{
   265  			GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
   266  			RawDescriptor: file_google_cloud_aiplatform_v1_tensorboard_run_proto_rawDesc,
   267  			NumEnums:      0,
   268  			NumMessages:   2,
   269  			NumExtensions: 0,
   270  			NumServices:   0,
   271  		},
   272  		GoTypes:           file_google_cloud_aiplatform_v1_tensorboard_run_proto_goTypes,
   273  		DependencyIndexes: file_google_cloud_aiplatform_v1_tensorboard_run_proto_depIdxs,
   274  		MessageInfos:      file_google_cloud_aiplatform_v1_tensorboard_run_proto_msgTypes,
   275  	}.Build()
   276  	File_google_cloud_aiplatform_v1_tensorboard_run_proto = out.File
   277  	file_google_cloud_aiplatform_v1_tensorboard_run_proto_rawDesc = nil
   278  	file_google_cloud_aiplatform_v1_tensorboard_run_proto_goTypes = nil
   279  	file_google_cloud_aiplatform_v1_tensorboard_run_proto_depIdxs = nil
   280  }