You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/aiplatform_v1.projects.locations.customJobs.html
+4Lines changed: 4 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -175,6 +175,7 @@ <h3>Method Details</h3>
175
175
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
176
176
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
177
177
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
178
+
"strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
178
179
"timeout": "A String", # The maximum job running time. The default is 7 days.
179
180
},
180
181
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -289,6 +290,7 @@ <h3>Method Details</h3>
289
290
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
290
291
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
291
292
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
293
+
"strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
292
294
"timeout": "A String", # The maximum job running time. The default is 7 days.
293
295
},
294
296
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -445,6 +447,7 @@ <h3>Method Details</h3>
445
447
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
446
448
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
447
449
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
450
+
"strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
448
451
"timeout": "A String", # The maximum job running time. The default is 7 days.
449
452
},
450
453
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -572,6 +575,7 @@ <h3>Method Details</h3>
572
575
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
573
576
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
574
577
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
578
+
"strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
575
579
"timeout": "A String", # The maximum job running time. The default is 7 days.
576
580
},
577
581
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
Copy file name to clipboardExpand all lines: docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -120,7 +120,7 @@ <h3>Method Details</h3>
120
120
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
121
121
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
122
122
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
123
-
"name": "A String", # Output only. The resource name of the DatasetVersion.
123
+
"name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
124
124
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
125
125
}
126
126
@@ -210,7 +210,7 @@ <h3>Method Details</h3>
210
210
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
211
211
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
212
212
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
213
-
"name": "A String", # Output only. The resource name of the DatasetVersion.
213
+
"name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
214
214
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
215
215
}</pre>
216
216
</div>
@@ -243,7 +243,7 @@ <h3>Method Details</h3>
243
243
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
244
244
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
245
245
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
246
-
"name": "A String", # Output only. The resource name of the DatasetVersion.
246
+
"name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
247
247
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
248
248
},
249
249
],
@@ -270,7 +270,7 @@ <h3>Method Details</h3>
270
270
<pre>Updates a DatasetVersion.
271
271
272
272
Args:
273
-
name: string, Output only. The resource name of the DatasetVersion. (required)
273
+
name: string, Output only. Identifier. The resource name of the DatasetVersion. (required)
274
274
body: object, The request body.
275
275
The object takes the form of:
276
276
@@ -281,7 +281,7 @@ <h3>Method Details</h3>
281
281
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
282
282
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
283
283
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
284
-
"name": "A String", # Output only. The resource name of the DatasetVersion.
284
+
"name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
285
285
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
286
286
}
287
287
@@ -301,7 +301,7 @@ <h3>Method Details</h3>
301
301
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
302
302
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
303
303
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
304
-
"name": "A String", # Output only. The resource name of the DatasetVersion.
304
+
"name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
305
305
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
Copy file name to clipboardExpand all lines: docs/dyn/aiplatform_v1.projects.locations.datasets.html
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -163,7 +163,7 @@ <h3>Method Details</h3>
163
163
"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
164
164
"metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
165
165
"modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
166
-
"name": "A String", # Output only. The resource name of the Dataset.
166
+
"name": "A String", # Output only. Identifier. The resource name of the Dataset.
167
167
"savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
168
168
{ # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
169
169
"annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset.
@@ -336,7 +336,7 @@ <h3>Method Details</h3>
336
336
"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
337
337
"metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
338
338
"modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
339
-
"name": "A String", # Output only. The resource name of the Dataset.
339
+
"name": "A String", # Output only. Identifier. The resource name of the Dataset.
340
340
"savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
341
341
{ # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
342
342
"annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset.
@@ -449,7 +449,7 @@ <h3>Method Details</h3>
449
449
"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
450
450
"metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
451
451
"modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
452
-
"name": "A String", # Output only. The resource name of the Dataset.
452
+
"name": "A String", # Output only. Identifier. The resource name of the Dataset.
453
453
"savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
454
454
{ # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
455
455
"annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset.
@@ -490,7 +490,7 @@ <h3>Method Details</h3>
490
490
<pre>Updates a Dataset.
491
491
492
492
Args:
493
-
name: string, Output only. The resource name of the Dataset. (required)
493
+
name: string, Output only. Identifier. The resource name of the Dataset. (required)
494
494
body: object, The request body.
495
495
The object takes the form of:
496
496
@@ -510,7 +510,7 @@ <h3>Method Details</h3>
510
510
"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
511
511
"metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
512
512
"modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
513
-
"name": "A String", # Output only. The resource name of the Dataset.
513
+
"name": "A String", # Output only. Identifier. The resource name of the Dataset.
514
514
"savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
515
515
{ # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
516
516
"annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset.
@@ -553,7 +553,7 @@ <h3>Method Details</h3>
553
553
"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
554
554
"metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
555
555
"modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
556
-
"name": "A String", # Output only. The resource name of the Dataset.
556
+
"name": "A String", # Output only. Identifier. The resource name of the Dataset.
557
557
"savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
558
558
{ # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
559
559
"annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset.
0 commit comments