-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
package-info.java
487 lines (485 loc) · 23.5 KB
/
package-info.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* A client to Vertex AI API
*
* <p>The interfaces provided are listed below, along with usage samples.
*
* <p>======================= DatasetServiceClient =======================
*
* <p>Service Description: The service that manages Vertex AI Dataset and its child resources.
*
* <p>Sample for DatasetServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
* DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
* Dataset response = datasetServiceClient.getDataset(name);
* }
* }</pre>
*
* <p>======================= DeploymentResourcePoolServiceClient =======================
*
* <p>Service Description: A service that manages the DeploymentResourcePool resource.
*
* <p>Sample for DeploymentResourcePoolServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DeploymentResourcePoolServiceClient deploymentResourcePoolServiceClient =
* DeploymentResourcePoolServiceClient.create()) {
* DeploymentResourcePoolName name =
* DeploymentResourcePoolName.of("[PROJECT]", "[LOCATION]", "[DEPLOYMENT_RESOURCE_POOL]");
* DeploymentResourcePool response =
* deploymentResourcePoolServiceClient.getDeploymentResourcePool(name);
* }
* }</pre>
*
* <p>======================= EndpointServiceClient =======================
*
* <p>Service Description: A service for managing Vertex AI's Endpoints.
*
* <p>Sample for EndpointServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (EndpointServiceClient endpointServiceClient = EndpointServiceClient.create()) {
* EndpointName name =
* EndpointName.ofProjectLocationEndpointName("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
* Endpoint response = endpointServiceClient.getEndpoint(name);
* }
* }</pre>
*
* <p>======================= FeatureOnlineStoreAdminServiceClient =======================
*
* <p>Service Description: The service that handles CRUD and List for resources for
* FeatureOnlineStore.
*
* <p>Sample for FeatureOnlineStoreAdminServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (FeatureOnlineStoreAdminServiceClient featureOnlineStoreAdminServiceClient =
* FeatureOnlineStoreAdminServiceClient.create()) {
* FeatureOnlineStoreName name =
* FeatureOnlineStoreName.of("[PROJECT]", "[LOCATION]", "[FEATURE_ONLINE_STORE]");
* FeatureOnlineStore response =
* featureOnlineStoreAdminServiceClient.getFeatureOnlineStore(name);
* }
* }</pre>
*
* <p>======================= FeatureOnlineStoreServiceClient =======================
*
* <p>Service Description: A service for fetching feature values from the online store.
*
* <p>Sample for FeatureOnlineStoreServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
* FeatureOnlineStoreServiceClient.create()) {
* FeatureViewName featureView =
* FeatureViewName.of("[PROJECT]", "[LOCATION]", "[FEATURE_ONLINE_STORE]", "[FEATURE_VIEW]");
* FeatureViewDataKey dataKey = FeatureViewDataKey.newBuilder().build();
* FetchFeatureValuesResponse response =
* featureOnlineStoreServiceClient.fetchFeatureValues(featureView, dataKey);
* }
* }</pre>
*
* <p>======================= FeatureRegistryServiceClient =======================
*
* <p>Service Description: The service that handles CRUD and List for resources for FeatureRegistry.
*
* <p>Sample for FeatureRegistryServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (FeatureRegistryServiceClient featureRegistryServiceClient =
* FeatureRegistryServiceClient.create()) {
* FeatureGroupName name = FeatureGroupName.of("[PROJECT]", "[LOCATION]", "[FEATURE_GROUP]");
* FeatureGroup response = featureRegistryServiceClient.getFeatureGroup(name);
* }
* }</pre>
*
* <p>======================= FeaturestoreOnlineServingServiceClient =======================
*
* <p>Service Description: A service for serving online feature values.
*
* <p>Sample for FeaturestoreOnlineServingServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
* FeaturestoreOnlineServingServiceClient.create()) {
* EntityTypeName entityType =
* EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
* ReadFeatureValuesResponse response =
* featurestoreOnlineServingServiceClient.readFeatureValues(entityType);
* }
* }</pre>
*
* <p>======================= FeaturestoreServiceClient =======================
*
* <p>Service Description: The service that handles CRUD and List for resources for Featurestore.
*
* <p>Sample for FeaturestoreServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (FeaturestoreServiceClient featurestoreServiceClient = FeaturestoreServiceClient.create()) {
* FeaturestoreName name = FeaturestoreName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]");
* Featurestore response = featurestoreServiceClient.getFeaturestore(name);
* }
* }</pre>
*
* <p>======================= IndexEndpointServiceClient =======================
*
* <p>Service Description: A service for managing Vertex AI's IndexEndpoints.
*
* <p>Sample for IndexEndpointServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (IndexEndpointServiceClient indexEndpointServiceClient =
* IndexEndpointServiceClient.create()) {
* IndexEndpointName name = IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
* IndexEndpoint response = indexEndpointServiceClient.getIndexEndpoint(name);
* }
* }</pre>
*
* <p>======================= IndexServiceClient =======================
*
* <p>Service Description: A service for creating and managing Vertex AI's Index resources.
*
* <p>Sample for IndexServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (IndexServiceClient indexServiceClient = IndexServiceClient.create()) {
* IndexName name = IndexName.of("[PROJECT]", "[LOCATION]", "[INDEX]");
* Index response = indexServiceClient.getIndex(name);
* }
* }</pre>
*
* <p>======================= JobServiceClient =======================
*
* <p>Service Description: A service for creating and managing Vertex AI's jobs.
*
* <p>Sample for JobServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* CustomJob customJob = CustomJob.newBuilder().build();
* CustomJob response = jobServiceClient.createCustomJob(parent, customJob);
* }
* }</pre>
*
* <p>======================= LlmUtilityServiceClient =======================
*
* <p>Service Description: Service for LLM related utility functions.
*
* <p>Sample for LlmUtilityServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LlmUtilityServiceClient llmUtilityServiceClient = LlmUtilityServiceClient.create()) {
* EndpointName endpoint =
* EndpointName.ofProjectLocationEndpointName("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
* List<Value> instances = new ArrayList<>();
* CountTokensResponse response = llmUtilityServiceClient.countTokens(endpoint, instances);
* }
* }</pre>
*
* <p>======================= MatchServiceClient =======================
*
* <p>Service Description: MatchService is a Google managed service for efficient vector similarity
* search at scale.
*
* <p>Sample for MatchServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (MatchServiceClient matchServiceClient = MatchServiceClient.create()) {
* FindNeighborsRequest request =
* FindNeighborsRequest.newBuilder()
* .setIndexEndpoint(
* IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString())
* .setDeployedIndexId("deployedIndexId-1101212953")
* .addAllQueries(new ArrayList<FindNeighborsRequest.Query>())
* .setReturnFullDatapoint(true)
* .build();
* FindNeighborsResponse response = matchServiceClient.findNeighbors(request);
* }
* }</pre>
*
* <p>======================= MetadataServiceClient =======================
*
* <p>Service Description: Service for reading and writing metadata entries.
*
* <p>Sample for MetadataServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (MetadataServiceClient metadataServiceClient = MetadataServiceClient.create()) {
* MetadataStoreName name = MetadataStoreName.of("[PROJECT]", "[LOCATION]", "[METADATA_STORE]");
* MetadataStore response = metadataServiceClient.getMetadataStore(name);
* }
* }</pre>
*
* <p>======================= MigrationServiceClient =======================
*
* <p>Service Description: A service that migrates resources from automl.googleapis.com,
* datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.
*
* <p>Sample for MigrationServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (MigrationServiceClient migrationServiceClient = MigrationServiceClient.create()) {
* GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
* Location response = migrationServiceClient.getLocation(request);
* }
* }</pre>
*
* <p>======================= ModelGardenServiceClient =======================
*
* <p>Service Description: The interface of Model Garden Service.
*
* <p>Sample for ModelGardenServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ModelGardenServiceClient modelGardenServiceClient = ModelGardenServiceClient.create()) {
* PublisherModelName name = PublisherModelName.of("[PUBLISHER]", "[MODEL]");
* PublisherModel response = modelGardenServiceClient.getPublisherModel(name);
* }
* }</pre>
*
* <p>======================= ModelServiceClient =======================
*
* <p>Service Description: A service for managing Vertex AI's machine learning Models.
*
* <p>Sample for ModelServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
* ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[MODEL]");
* Model response = modelServiceClient.getModel(name);
* }
* }</pre>
*
* <p>======================= PipelineServiceClient =======================
*
* <p>Service Description: A service for creating and managing Vertex AI's pipelines. This includes
* both `TrainingPipeline` resources (used for AutoML and custom training) and `PipelineJob`
* resources (used for Vertex AI Pipelines).
*
* <p>Sample for PipelineServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (PipelineServiceClient pipelineServiceClient = PipelineServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* TrainingPipeline trainingPipeline = TrainingPipeline.newBuilder().build();
* TrainingPipeline response =
* pipelineServiceClient.createTrainingPipeline(parent, trainingPipeline);
* }
* }</pre>
*
* <p>======================= PredictionServiceClient =======================
*
* <p>Service Description: A service for online predictions and explanations.
*
* <p>Sample for PredictionServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (PredictionServiceClient predictionServiceClient = PredictionServiceClient.create()) {
* EndpointName endpoint =
* EndpointName.ofProjectLocationEndpointName("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
* List<Value> instances = new ArrayList<>();
* Value parameters = Value.newBuilder().setBoolValue(true).build();
* PredictResponse response = predictionServiceClient.predict(endpoint, instances, parameters);
* }
* }</pre>
*
* <p>======================= ScheduleServiceClient =======================
*
* <p>Service Description: A service for creating and managing Vertex AI's Schedule resources to
* periodically launch shceudled runs to make API calls.
*
* <p>Sample for ScheduleServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ScheduleServiceClient scheduleServiceClient = ScheduleServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* Schedule schedule = Schedule.newBuilder().build();
* Schedule response = scheduleServiceClient.createSchedule(parent, schedule);
* }
* }</pre>
*
* <p>======================= SpecialistPoolServiceClient =======================
*
* <p>Service Description: A service for creating and managing Customer SpecialistPools. When
* customers start Data Labeling jobs, they can reuse/create Specialist Pools to bring their own
* Specialists to label the data. Customers can add/remove Managers for the Specialist Pool on Cloud
* console, then Managers will get email notifications to manage Specialists and tasks on
* CrowdCompute console.
*
* <p>Sample for SpecialistPoolServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SpecialistPoolServiceClient specialistPoolServiceClient =
* SpecialistPoolServiceClient.create()) {
* SpecialistPoolName name =
* SpecialistPoolName.of("[PROJECT]", "[LOCATION]", "[SPECIALIST_POOL]");
* SpecialistPool response = specialistPoolServiceClient.getSpecialistPool(name);
* }
* }</pre>
*
* <p>======================= TensorboardServiceClient =======================
*
* <p>Service Description: TensorboardService
*
* <p>Sample for TensorboardServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (TensorboardServiceClient tensorboardServiceClient = TensorboardServiceClient.create()) {
* TensorboardName name = TensorboardName.of("[PROJECT]", "[LOCATION]", "[TENSORBOARD]");
* Tensorboard response = tensorboardServiceClient.getTensorboard(name);
* }
* }</pre>
*
* <p>======================= VizierServiceClient =======================
*
* <p>Service Description: Vertex AI Vizier API.
*
* <p>Vertex AI Vizier is a service to solve blackbox optimization problems, such as tuning machine
* learning hyperparameters and searching over deep learning architectures.
*
* <p>Sample for VizierServiceClient:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (VizierServiceClient vizierServiceClient = VizierServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* Study study = Study.newBuilder().build();
* Study response = vizierServiceClient.createStudy(parent, study);
* }
* }</pre>
*/
@Generated("by gapic-generator-java")
package com.google.cloud.aiplatform.v1;
import javax.annotation.Generated;