Skip to content

Commit efbe03d

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
feat: making network arg optional in aiplatform v1beta1 custom_job.proto
feat: DeploymentResourcePool and DeployementResourcePoolService added to aiplatform v1beta1 model.proto (cl/463147866) docs: doc edits to aiplatform v1beta1 job_service.proto, model_service.proto, pipeline_service.proto, saved_query.proto, study.proto, types.proto PiperOrigin-RevId: 463932106
1 parent 378a63c commit efbe03d

8 files changed

Lines changed: 85 additions & 70 deletions

File tree

‎google/cloud/aiplatform/v1beta1/custom_job.proto‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ message CustomJob {
106106
}
107107

108108
// Represents the spec of a CustomJob.
109-
// Next Id: 14
109+
// Next Id: 15
110110
message CustomJobSpec {
111111
// Required. The spec of the worker pools including machine type and Docker image.
112112
// All worker pools except the first one are optional and can be skipped by
@@ -123,7 +123,7 @@ message CustomJobSpec {
123123
// for the CustomJob's project is used.
124124
string service_account = 4;
125125

126-
// The full name of the Compute Engine
126+
// Optional. The full name of the Compute Engine
127127
// [network](/compute/docs/networks-and-firewalls#networks) to which the Job
128128
// should be peered. For example, `projects/12345/global/networks/myVPC`.
129129
// [Format](/compute/docs/reference/rest/v1/networks/insert)
@@ -136,9 +136,12 @@ message CustomJobSpec {
136136
// AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering).
137137
//
138138
// If this field is left unspecified, the job is not peered with any network.
139-
string network = 5 [(google.api.resource_reference) = {
140-
type: "compute.googleapis.com/Network"
141-
}];
139+
string network = 5 [
140+
(google.api.field_behavior) = OPTIONAL,
141+
(google.api.resource_reference) = {
142+
type: "compute.googleapis.com/Network"
143+
}
144+
];
142145

143146
// Optional. A list of names for the reserved ip ranges under the VPC network
144147
// that can be used for this job.

‎google/cloud/aiplatform/v1beta1/dataset_service.proto‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,7 @@ message ListDatasetsRequest {
224224
// * A key including a space must be quoted. `labels."a key"`.
225225
//
226226
// Some examples:
227+
//
227228
// * `displayName="myDisplayName"`
228229
// * `labels.myKey="myValue"`
229230
string filter = 2;
@@ -240,6 +241,7 @@ message ListDatasetsRequest {
240241
// A comma-separated list of fields to order by, sorted in ascending order.
241242
// Use "desc" after a field name for descending.
242243
// Supported fields:
244+
//
243245
// * `display_name`
244246
// * `create_time`
245247
// * `update_time`
@@ -397,7 +399,8 @@ message ListSavedQueriesRequest {
397399

398400
// Response message for [DatasetService.ListSavedQueries][google.cloud.aiplatform.v1beta1.DatasetService.ListSavedQueries].
399401
message ListSavedQueriesResponse {
400-
// A list of SavedQueries that match the specified filter in the request.
402+
// A list of SavedQueries that matches the specified filter in the
403+
// request.
401404
repeated SavedQuery saved_queries = 1;
402405

403406
// The standard List next-page token.

‎google/cloud/aiplatform/v1beta1/job_service.proto‎

Lines changed: 47 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -384,19 +384,17 @@ message ListCustomJobsRequest {
384384
//
385385
// Supported fields:
386386
//
387-
// * `display_name` supports = and !=.
388-
//
389-
// * `state` supports = and !=.
387+
// * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
388+
// * `state` supports `=`, `!=` comparisons.
389+
// * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
390+
// `create_time` must be in RFC 3339 format.
390391
//
391392
// Some examples of using the filter are:
392393
//
393-
// * `state="JOB_STATE_SUCCEEDED" AND display_name="my_job"`
394-
//
395-
// * `state="JOB_STATE_RUNNING" OR display_name="my_job"`
396-
//
397-
// * `NOT display_name="my_job"`
398-
//
399-
// * `state="JOB_STATE_FAILED"`
394+
// * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
395+
// * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
396+
// * `NOT display_name="my_job"`
397+
// * `create_time>"2021-05-18T00:00:00Z"`
400398
string filter = 2;
401399

402400
// The standard list page size.
@@ -491,19 +489,17 @@ message ListDataLabelingJobsRequest {
491489
//
492490
// Supported fields:
493491
//
494-
// * `display_name` supports = and !=.
495-
//
496-
// * `state` supports = and !=.
492+
// * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
493+
// * `state` supports `=`, `!=` comparisons.
494+
// * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
495+
// `create_time` must be in RFC 3339 format.
497496
//
498497
// Some examples of using the filter are:
499498
//
500-
// * `state="JOB_STATE_SUCCEEDED" AND display_name="my_job"`
501-
//
502-
// * `state="JOB_STATE_RUNNING" OR display_name="my_job"`
503-
//
504-
// * `NOT display_name="my_job"`
505-
//
506-
// * `state="JOB_STATE_FAILED"`
499+
// * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
500+
// * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
501+
// * `NOT display_name="my_job"`
502+
// * `create_time>"2021-05-18T00:00:00Z"`
507503
string filter = 2;
508504

509505
// The standard list page size.
@@ -603,19 +599,17 @@ message ListHyperparameterTuningJobsRequest {
603599
//
604600
// Supported fields:
605601
//
606-
// * `display_name` supports = and !=.
607-
//
608-
// * `state` supports = and !=.
602+
// * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
603+
// * `state` supports `=`, `!=` comparisons.
604+
// * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
605+
// `create_time` must be in RFC 3339 format.
609606
//
610607
// Some examples of using the filter are:
611608
//
612-
// * `state="JOB_STATE_SUCCEEDED" AND display_name="my_job"`
613-
//
614-
// * `state="JOB_STATE_RUNNING" OR display_name="my_job"`
615-
//
616-
// * `NOT display_name="my_job"`
617-
//
618-
// * `state="JOB_STATE_FAILED"`
609+
// * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
610+
// * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
611+
// * `NOT display_name="my_job"`
612+
// * `create_time>"2021-05-18T00:00:00Z"`
619613
string filter = 2;
620614

621615
// The standard list page size.
@@ -712,21 +706,18 @@ message ListBatchPredictionJobsRequest {
712706
//
713707
// Supported fields:
714708
//
715-
// * `display_name` supports = and !=.
716-
//
717-
// * `state` supports = and !=.
718-
//
719-
// * `model_display_name` supports = and !=
709+
// * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
710+
// * `model_display_name` supports `=`, `!=` comparisons.
711+
// * `state` supports `=`, `!=` comparisons.
712+
// * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
713+
// `create_time` must be in RFC 3339 format.
720714
//
721715
// Some examples of using the filter are:
722716
//
723-
// * `state="JOB_STATE_SUCCEEDED" AND display_name="my_job"`
724-
//
725-
// * `state="JOB_STATE_RUNNING" OR display_name="my_job"`
726-
//
727-
// * `NOT display_name="my_job"`
728-
//
729-
// * `state="JOB_STATE_FAILED"`
717+
// * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
718+
// * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
719+
// * `NOT display_name="my_job"`
720+
// * `create_time>"2021-05-18T00:00:00Z"`
730721
string filter = 2;
731722

732723
// The standard list page size.
@@ -893,6 +884,20 @@ message ListModelDeploymentMonitoringJobsRequest {
893884
];
894885

895886
// The standard list filter.
887+
//
888+
// Supported fields:
889+
//
890+
// * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
891+
// * `state` supports `=`, `!=` comparisons.
892+
// * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
893+
// `create_time` must be in RFC 3339 format.
894+
//
895+
// Some examples of using the filter are:
896+
//
897+
// * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
898+
// * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
899+
// * `NOT display_name="my_job"`
900+
// * `create_time>"2021-05-18T00:00:00Z"`
896901
string filter = 2;
897902

898903
// The standard list page size.

‎google/cloud/aiplatform/v1beta1/model_service.proto‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,7 @@ message ListModelsRequest {
297297
// * A key including a space must be quoted. `labels."a key"`.
298298
//
299299
// Some examples:
300+
//
300301
// * `model=1234`
301302
// * `displayName="myDisplayName"`
302303
// * `labels.myKey="myValue"`
@@ -353,6 +354,7 @@ message ListModelVersionsRequest {
353354
// * A key including a space must be quoted. `labels."a key"`.
354355
//
355356
// Some examples:
357+
//
356358
// * `labels.myKey="myValue"`
357359
string filter = 4;
358360

‎google/cloud/aiplatform/v1beta1/pipeline_service.proto‎

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -193,21 +193,22 @@ message ListTrainingPipelinesRequest {
193193
];
194194

195195
// The standard list filter.
196-
// Supported fields:
197196
//
198-
// * `display_name` supports = and !=.
197+
// Supported fields:
199198
//
200-
// * `state` supports = and !=.
199+
// * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
200+
// * `state` supports `=`, `!=` comparisons.
201+
// * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard.
202+
// * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
203+
// `create_time` must be in RFC 3339 format.
201204
//
202205
// Some examples of using the filter are:
203206
//
204-
// * `state="PIPELINE_STATE_SUCCEEDED" AND display_name="my_pipeline"`
205-
//
206-
// * `state="PIPELINE_STATE_RUNNING" OR display_name="my_pipeline"`
207-
//
208-
// * `NOT display_name="my_pipeline"`
209-
//
210-
// * `state="PIPELINE_STATE_FAILED"`
207+
// * `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"`
208+
// * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"`
209+
// * `NOT display_name="my_pipeline"`
210+
// * `create_time>"2021-05-18T00:00:00Z"`
211+
// * `training_task_definition:"*automl_text_classification*"`
211212
string filter = 2;
212213

213214
// The standard list page size.
@@ -312,8 +313,8 @@ message ListPipelineJobsRequest {
312313
// * `pipeline_name`: Supports `=` and `!=` comparisons.
313314
// * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard.
314315
// * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard.
315-
// for example, can check if pipeline's display_name contains *step* by doing
316-
// display_name:\"*step*\"
316+
// for example, can check if pipeline's display_name contains *step* by
317+
// doing display_name:\"*step*\"
317318
// * `state`: Supports `=` and `!=` comparisons.
318319
// * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons.
319320
// Values must be in RFC 3339 format.
@@ -324,7 +325,7 @@ message ListPipelineJobsRequest {
324325
// * `labels`: Supports key-value equality and key presence.
325326
// * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard.
326327
// * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:`
327-
// wildcard.
328+
// wildcard.
328329
//
329330
// Filter expressions can be combined together using logical operators
330331
// (`AND` & `OR`).
@@ -359,6 +360,7 @@ message ListPipelineJobsRequest {
359360
// there are multiple jobs having the same create time, order them by the end
360361
// time in ascending order. if order_by is not specified, it will order by
361362
// default order is create time in descending order. Supported fields:
363+
//
362364
// * `create_time`
363365
// * `update_time`
364366
// * `end_time`

‎google/cloud/aiplatform/v1beta1/saved_query.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ message SavedQuery {
7474
// Output only. Number of AnnotationSpecs in the context of the SavedQuery.
7575
int32 annotation_spec_count = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
7676

77-
// Used to perform a consistent read-modify-write update. If not set, a blind
77+
// Used to perform consistent read-modify-write updates. If not set, a blind
7878
// "overwrite" update happens.
7979
string etag = 8;
8080

‎google/cloud/aiplatform/v1beta1/study.proto‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ message StudySpec {
225225
// offered starting point.
226226
//
227227
// Currently only supported by the Vertex AI Vizier service. Not supported
228-
// by HyperparamterTuningJob or TrainingPipeline.
228+
// by HyperparameterTuningJob or TrainingPipeline.
229229
optional double default_value = 4;
230230
}
231231

@@ -242,7 +242,7 @@ message StudySpec {
242242
// offered starting point.
243243
//
244244
// Currently only supported by the Vertex AI Vizier service. Not supported
245-
// by HyperparamterTuningJob or TrainingPipeline.
245+
// by HyperparameterTuningJob or TrainingPipeline.
246246
optional int64 default_value = 4;
247247
}
248248

@@ -255,8 +255,8 @@ message StudySpec {
255255
// relatively good starting point. Unset value signals that there is no
256256
// offered starting point.
257257
//
258-
// Currently only supported by the Vizier service. Not supported by
259-
// HyperparamterTuningJob or TrainingPipeline.
258+
// Currently only supported by the Vertex AI Vizier service. Not supported
259+
// by HyperparameterTuningJob or TrainingPipeline.
260260
optional string default_value = 3;
261261
}
262262

@@ -273,8 +273,8 @@ message StudySpec {
273273
// offered starting point. It automatically rounds to the
274274
// nearest feasible discrete point.
275275
//
276-
// Currently only supported by the Vizier service. Not supported by
277-
// HyperparamterTuningJob or TrainingPipeline.
276+
// Currently only supported by the Vertex AI Vizier service. Not supported
277+
// by HyperparameterTuningJob or TrainingPipeline.
278278
optional double default_value = 3;
279279
}
280280

@@ -568,7 +568,7 @@ message StudySpec {
568568

569569
// The observation noise level of the study.
570570
// Currently only supported by the Vertex AI Vizier service. Not supported by
571-
// HyperparamterTuningJob or TrainingPipeline.
571+
// HyperparameterTuningJob or TrainingPipeline.
572572
ObservationNoise observation_noise = 6;
573573

574574
// Describe which measurement selection type will be used

‎google/cloud/aiplatform/v1beta1/types.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ message BoolArray {
3232

3333
// A list of double values.
3434
message DoubleArray {
35-
// A list of bool values.
35+
// A list of double values.
3636
repeated double values = 1;
3737
}
3838

0 commit comments

Comments
 (0)