/
PipelineServiceClient.java
2282 lines (2174 loc) · 101 KB
/
PipelineServiceClient.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
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2023 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.
*/
package com.google.cloud.aiplatform.v1;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.aiplatform.v1.stub.PipelineServiceStub;
import com.google.cloud.aiplatform.v1.stub.PipelineServiceStubSettings;
import com.google.cloud.location.GetLocationRequest;
import com.google.cloud.location.ListLocationsRequest;
import com.google.cloud.location.ListLocationsResponse;
import com.google.cloud.location.Location;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.iam.v1.GetIamPolicyRequest;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import com.google.iam.v1.TestIamPermissionsRequest;
import com.google.iam.v1.TestIamPermissionsResponse;
import com.google.longrunning.Operation;
import com.google.longrunning.OperationsClient;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* 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>This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
*
* <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>Note: close() needs to be called on the PipelineServiceClient object to clean up resources
* such as threads. In the example above, try-with-resources is used, which automatically calls
* close().
*
* <p>The surface of this class includes several types of Java methods for each of the API's
* methods:
*
* <ol>
* <li>A "flattened" method. With this type of method, the fields of the request type have been
* converted into function parameters. It may be the case that not all fields are available as
* parameters, and not every API method will have a flattened method entry point.
* <li>A "request object" method. This type of method only takes one parameter, a request object,
* which must be constructed before the call. Not every API method will have a request object
* method.
* <li>A "callable" method. This type of method takes no parameters and returns an immutable API
* callable object, which can be used to initiate calls to the service.
* </ol>
*
* <p>See the individual methods for example code.
*
* <p>Many parameters require resource names to be formatted in a particular way. To assist with
* these names, this class includes a format method for each type of name, and additionally a parse
* method to extract the individual identifiers contained within names that are returned.
*
* <p>This class can be customized by passing in a custom instance of PipelineServiceSettings to
* create(). For example:
*
* <p>To customize credentials:
*
* <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
* PipelineServiceSettings pipelineServiceSettings =
* PipelineServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* PipelineServiceClient pipelineServiceClient =
* PipelineServiceClient.create(pipelineServiceSettings);
* }</pre>
*
* <p>To customize the endpoint:
*
* <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
* PipelineServiceSettings pipelineServiceSettings =
* PipelineServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* PipelineServiceClient pipelineServiceClient =
* PipelineServiceClient.create(pipelineServiceSettings);
* }</pre>
*
* <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class PipelineServiceClient implements BackgroundResource {
private final PipelineServiceSettings settings;
private final PipelineServiceStub stub;
private final OperationsClient operationsClient;
/** Constructs an instance of PipelineServiceClient with default settings. */
public static final PipelineServiceClient create() throws IOException {
return create(PipelineServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of PipelineServiceClient, using the given settings. The channels are
* created based on the settings passed in, or defaults for any settings that are not set.
*/
public static final PipelineServiceClient create(PipelineServiceSettings settings)
throws IOException {
return new PipelineServiceClient(settings);
}
/**
* Constructs an instance of PipelineServiceClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(PipelineServiceSettings).
*/
public static final PipelineServiceClient create(PipelineServiceStub stub) {
return new PipelineServiceClient(stub);
}
/**
* Constructs an instance of PipelineServiceClient, using the given settings. This is protected so
* that it is easy to make a subclass, but otherwise, the static factory methods should be
* preferred.
*/
protected PipelineServiceClient(PipelineServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((PipelineServiceStubSettings) settings.getStubSettings()).createStub();
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
protected PipelineServiceClient(PipelineServiceStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
public final PipelineServiceSettings getSettings() {
return settings;
}
public PipelineServiceStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
public final OperationsClient getOperationsClient() {
return operationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.
*
* <p>Sample code:
*
* <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>
*
* @param parent Required. The resource name of the Location to create the TrainingPipeline in.
* Format: `projects/{project}/locations/{location}`
* @param trainingPipeline Required. The TrainingPipeline to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TrainingPipeline createTrainingPipeline(
LocationName parent, TrainingPipeline trainingPipeline) {
CreateTrainingPipelineRequest request =
CreateTrainingPipelineRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setTrainingPipeline(trainingPipeline)
.build();
return createTrainingPipeline(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.
*
* <p>Sample code:
*
* <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()) {
* String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
* TrainingPipeline trainingPipeline = TrainingPipeline.newBuilder().build();
* TrainingPipeline response =
* pipelineServiceClient.createTrainingPipeline(parent, trainingPipeline);
* }
* }</pre>
*
* @param parent Required. The resource name of the Location to create the TrainingPipeline in.
* Format: `projects/{project}/locations/{location}`
* @param trainingPipeline Required. The TrainingPipeline to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TrainingPipeline createTrainingPipeline(
String parent, TrainingPipeline trainingPipeline) {
CreateTrainingPipelineRequest request =
CreateTrainingPipelineRequest.newBuilder()
.setParent(parent)
.setTrainingPipeline(trainingPipeline)
.build();
return createTrainingPipeline(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.
*
* <p>Sample code:
*
* <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()) {
* CreateTrainingPipelineRequest request =
* CreateTrainingPipelineRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setTrainingPipeline(TrainingPipeline.newBuilder().build())
* .build();
* TrainingPipeline response = pipelineServiceClient.createTrainingPipeline(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TrainingPipeline createTrainingPipeline(CreateTrainingPipelineRequest request) {
return createTrainingPipelineCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.
*
* <p>Sample code:
*
* <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()) {
* CreateTrainingPipelineRequest request =
* CreateTrainingPipelineRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setTrainingPipeline(TrainingPipeline.newBuilder().build())
* .build();
* ApiFuture<TrainingPipeline> future =
* pipelineServiceClient.createTrainingPipelineCallable().futureCall(request);
* // Do something.
* TrainingPipeline response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<CreateTrainingPipelineRequest, TrainingPipeline>
createTrainingPipelineCallable() {
return stub.createTrainingPipelineCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a TrainingPipeline.
*
* <p>Sample code:
*
* <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()) {
* TrainingPipelineName name =
* TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]");
* TrainingPipeline response = pipelineServiceClient.getTrainingPipeline(name);
* }
* }</pre>
*
* @param name Required. The name of the TrainingPipeline resource. Format:
* `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TrainingPipeline getTrainingPipeline(TrainingPipelineName name) {
GetTrainingPipelineRequest request =
GetTrainingPipelineRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
return getTrainingPipeline(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a TrainingPipeline.
*
* <p>Sample code:
*
* <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()) {
* String name =
* TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]").toString();
* TrainingPipeline response = pipelineServiceClient.getTrainingPipeline(name);
* }
* }</pre>
*
* @param name Required. The name of the TrainingPipeline resource. Format:
* `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TrainingPipeline getTrainingPipeline(String name) {
GetTrainingPipelineRequest request =
GetTrainingPipelineRequest.newBuilder().setName(name).build();
return getTrainingPipeline(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a TrainingPipeline.
*
* <p>Sample code:
*
* <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()) {
* GetTrainingPipelineRequest request =
* GetTrainingPipelineRequest.newBuilder()
* .setName(
* TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
* .toString())
* .build();
* TrainingPipeline response = pipelineServiceClient.getTrainingPipeline(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TrainingPipeline getTrainingPipeline(GetTrainingPipelineRequest request) {
return getTrainingPipelineCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a TrainingPipeline.
*
* <p>Sample code:
*
* <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()) {
* GetTrainingPipelineRequest request =
* GetTrainingPipelineRequest.newBuilder()
* .setName(
* TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
* .toString())
* .build();
* ApiFuture<TrainingPipeline> future =
* pipelineServiceClient.getTrainingPipelineCallable().futureCall(request);
* // Do something.
* TrainingPipeline response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<GetTrainingPipelineRequest, TrainingPipeline>
getTrainingPipelineCallable() {
return stub.getTrainingPipelineCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists TrainingPipelines in a Location.
*
* <p>Sample code:
*
* <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]");
* for (TrainingPipeline element :
* pipelineServiceClient.listTrainingPipelines(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param parent Required. The resource name of the Location to list the TrainingPipelines from.
* Format: `projects/{project}/locations/{location}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTrainingPipelinesPagedResponse listTrainingPipelines(LocationName parent) {
ListTrainingPipelinesRequest request =
ListTrainingPipelinesRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listTrainingPipelines(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists TrainingPipelines in a Location.
*
* <p>Sample code:
*
* <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()) {
* String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
* for (TrainingPipeline element :
* pipelineServiceClient.listTrainingPipelines(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param parent Required. The resource name of the Location to list the TrainingPipelines from.
* Format: `projects/{project}/locations/{location}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTrainingPipelinesPagedResponse listTrainingPipelines(String parent) {
ListTrainingPipelinesRequest request =
ListTrainingPipelinesRequest.newBuilder().setParent(parent).build();
return listTrainingPipelines(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists TrainingPipelines in a Location.
*
* <p>Sample code:
*
* <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()) {
* ListTrainingPipelinesRequest request =
* ListTrainingPipelinesRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setReadMask(FieldMask.newBuilder().build())
* .build();
* for (TrainingPipeline element :
* pipelineServiceClient.listTrainingPipelines(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTrainingPipelinesPagedResponse listTrainingPipelines(
ListTrainingPipelinesRequest request) {
return listTrainingPipelinesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists TrainingPipelines in a Location.
*
* <p>Sample code:
*
* <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()) {
* ListTrainingPipelinesRequest request =
* ListTrainingPipelinesRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setReadMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture<TrainingPipeline> future =
* pipelineServiceClient.listTrainingPipelinesPagedCallable().futureCall(request);
* // Do something.
* for (TrainingPipeline element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*/
public final UnaryCallable<ListTrainingPipelinesRequest, ListTrainingPipelinesPagedResponse>
listTrainingPipelinesPagedCallable() {
return stub.listTrainingPipelinesPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists TrainingPipelines in a Location.
*
* <p>Sample code:
*
* <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()) {
* ListTrainingPipelinesRequest request =
* ListTrainingPipelinesRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setReadMask(FieldMask.newBuilder().build())
* .build();
* while (true) {
* ListTrainingPipelinesResponse response =
* pipelineServiceClient.listTrainingPipelinesCallable().call(request);
* for (TrainingPipeline element : response.getTrainingPipelinesList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }</pre>
*/
public final UnaryCallable<ListTrainingPipelinesRequest, ListTrainingPipelinesResponse>
listTrainingPipelinesCallable() {
return stub.listTrainingPipelinesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a TrainingPipeline.
*
* <p>Sample code:
*
* <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()) {
* TrainingPipelineName name =
* TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]");
* pipelineServiceClient.deleteTrainingPipelineAsync(name).get();
* }
* }</pre>
*
* @param name Required. The name of the TrainingPipeline resource to be deleted. Format:
* `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Empty, DeleteOperationMetadata> deleteTrainingPipelineAsync(
TrainingPipelineName name) {
DeleteTrainingPipelineRequest request =
DeleteTrainingPipelineRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
return deleteTrainingPipelineAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a TrainingPipeline.
*
* <p>Sample code:
*
* <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()) {
* String name =
* TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]").toString();
* pipelineServiceClient.deleteTrainingPipelineAsync(name).get();
* }
* }</pre>
*
* @param name Required. The name of the TrainingPipeline resource to be deleted. Format:
* `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Empty, DeleteOperationMetadata> deleteTrainingPipelineAsync(
String name) {
DeleteTrainingPipelineRequest request =
DeleteTrainingPipelineRequest.newBuilder().setName(name).build();
return deleteTrainingPipelineAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a TrainingPipeline.
*
* <p>Sample code:
*
* <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()) {
* DeleteTrainingPipelineRequest request =
* DeleteTrainingPipelineRequest.newBuilder()
* .setName(
* TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
* .toString())
* .build();
* pipelineServiceClient.deleteTrainingPipelineAsync(request).get();
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Empty, DeleteOperationMetadata> deleteTrainingPipelineAsync(
DeleteTrainingPipelineRequest request) {
return deleteTrainingPipelineOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a TrainingPipeline.
*
* <p>Sample code:
*
* <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()) {
* DeleteTrainingPipelineRequest request =
* DeleteTrainingPipelineRequest.newBuilder()
* .setName(
* TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
* .toString())
* .build();
* OperationFuture<Empty, DeleteOperationMetadata> future =
* pipelineServiceClient.deleteTrainingPipelineOperationCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }</pre>
*/
public final OperationCallable<DeleteTrainingPipelineRequest, Empty, DeleteOperationMetadata>
deleteTrainingPipelineOperationCallable() {
return stub.deleteTrainingPipelineOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a TrainingPipeline.
*
* <p>Sample code:
*
* <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()) {
* DeleteTrainingPipelineRequest request =
* DeleteTrainingPipelineRequest.newBuilder()
* .setName(
* TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
* .toString())
* .build();
* ApiFuture<Operation> future =
* pipelineServiceClient.deleteTrainingPipelineCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }</pre>
*/
public final UnaryCallable<DeleteTrainingPipelineRequest, Operation>
deleteTrainingPipelineCallable() {
return stub.deleteTrainingPipelineCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The
* server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can
* use
* [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline]
* or other methods to check whether the cancellation succeeded or whether the pipeline completed
* despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead
* it becomes a pipeline with a
* [TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error] value with a
* [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and
* [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state] is set to
* `CANCELLED`.
*
* <p>Sample code:
*
* <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()) {
* TrainingPipelineName name =
* TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]");
* pipelineServiceClient.cancelTrainingPipeline(name);
* }
* }</pre>
*
* @param name Required. The name of the TrainingPipeline to cancel. Format:
* `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void cancelTrainingPipeline(TrainingPipelineName name) {
CancelTrainingPipelineRequest request =
CancelTrainingPipelineRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
cancelTrainingPipeline(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The
* server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can
* use
* [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline]
* or other methods to check whether the cancellation succeeded or whether the pipeline completed
* despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead
* it becomes a pipeline with a
* [TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error] value with a
* [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and
* [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state] is set to
* `CANCELLED`.
*
* <p>Sample code:
*
* <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()) {
* String name =
* TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]").toString();
* pipelineServiceClient.cancelTrainingPipeline(name);
* }
* }</pre>
*
* @param name Required. The name of the TrainingPipeline to cancel. Format:
* `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void cancelTrainingPipeline(String name) {
CancelTrainingPipelineRequest request =
CancelTrainingPipelineRequest.newBuilder().setName(name).build();
cancelTrainingPipeline(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The
* server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can
* use
* [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline]
* or other methods to check whether the cancellation succeeded or whether the pipeline completed
* despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead
* it becomes a pipeline with a
* [TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error] value with a
* [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and
* [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state] is set to
* `CANCELLED`.
*
* <p>Sample code:
*
* <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()) {
* CancelTrainingPipelineRequest request =
* CancelTrainingPipelineRequest.newBuilder()
* .setName(
* TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
* .toString())
* .build();
* pipelineServiceClient.cancelTrainingPipeline(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void cancelTrainingPipeline(CancelTrainingPipelineRequest request) {
cancelTrainingPipelineCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The
* server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can
* use
* [PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline]
* or other methods to check whether the cancellation succeeded or whether the pipeline completed
* despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead
* it becomes a pipeline with a
* [TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error] value with a
* [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`, and
* [TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state] is set to
* `CANCELLED`.
*
* <p>Sample code:
*
* <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()) {
* CancelTrainingPipelineRequest request =
* CancelTrainingPipelineRequest.newBuilder()
* .setName(
* TrainingPipelineName.of("[PROJECT]", "[LOCATION]", "[TRAINING_PIPELINE]")
* .toString())
* .build();
* ApiFuture<Empty> future =
* pipelineServiceClient.cancelTrainingPipelineCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }</pre>
*/
public final UnaryCallable<CancelTrainingPipelineRequest, Empty>
cancelTrainingPipelineCallable() {
return stub.cancelTrainingPipelineCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a PipelineJob. A PipelineJob will run immediately when created.
*
* <p>Sample code:
*
* <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]");
* PipelineJob pipelineJob = PipelineJob.newBuilder().build();
* String pipelineJobId = "pipelineJobId-1711315914";
* PipelineJob response =
* pipelineServiceClient.createPipelineJob(parent, pipelineJob, pipelineJobId);
* }
* }</pre>
*
* @param parent Required. The resource name of the Location to create the PipelineJob in. Format:
* `projects/{project}/locations/{location}`
* @param pipelineJob Required. The PipelineJob to create.
* @param pipelineJobId The ID to use for the PipelineJob, which will become the final component
* of the PipelineJob name. If not provided, an ID will be automatically generated.
* <p>This value should be less than 128 characters, and valid characters are `/[a-z][0-9]-/`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final PipelineJob createPipelineJob(
LocationName parent, PipelineJob pipelineJob, String pipelineJobId) {
CreatePipelineJobRequest request =
CreatePipelineJobRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setPipelineJob(pipelineJob)
.setPipelineJobId(pipelineJobId)
.build();
return createPipelineJob(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a PipelineJob. A PipelineJob will run immediately when created.
*
* <p>Sample code:
*
* <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()) {
* String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
* PipelineJob pipelineJob = PipelineJob.newBuilder().build();
* String pipelineJobId = "pipelineJobId-1711315914";
* PipelineJob response =
* pipelineServiceClient.createPipelineJob(parent, pipelineJob, pipelineJobId);
* }
* }</pre>
*
* @param parent Required. The resource name of the Location to create the PipelineJob in. Format:
* `projects/{project}/locations/{location}`
* @param pipelineJob Required. The PipelineJob to create.
* @param pipelineJobId The ID to use for the PipelineJob, which will become the final component
* of the PipelineJob name. If not provided, an ID will be automatically generated.