/
grpc_asyncio.py
889 lines (795 loc) · 37.5 KB
/
grpc_asyncio.py
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
# -*- coding: utf-8 -*-
# Copyright 2020 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
#
# http://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.
#
import warnings
from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple
from google.api_core import gapic_v1 # type: ignore
from google.api_core import grpc_helpers_async # type: ignore
from google.api_core import operations_v1 # type: ignore
from google import auth # type: ignore
from google.auth import credentials # type: ignore
from google.auth.transport.grpc import SslCredentials # type: ignore
import grpc # type: ignore
from grpc.experimental import aio # type: ignore
from google.cloud.aiplatform_v1beta1.types import batch_prediction_job
from google.cloud.aiplatform_v1beta1.types import (
batch_prediction_job as gca_batch_prediction_job,
)
from google.cloud.aiplatform_v1beta1.types import custom_job
from google.cloud.aiplatform_v1beta1.types import custom_job as gca_custom_job
from google.cloud.aiplatform_v1beta1.types import data_labeling_job
from google.cloud.aiplatform_v1beta1.types import (
data_labeling_job as gca_data_labeling_job,
)
from google.cloud.aiplatform_v1beta1.types import hyperparameter_tuning_job
from google.cloud.aiplatform_v1beta1.types import (
hyperparameter_tuning_job as gca_hyperparameter_tuning_job,
)
from google.cloud.aiplatform_v1beta1.types import job_service
from google.longrunning import operations_pb2 as operations # type: ignore
from google.protobuf import empty_pb2 as empty # type: ignore
from .base import JobServiceTransport, DEFAULT_CLIENT_INFO
from .grpc import JobServiceGrpcTransport
class JobServiceGrpcAsyncIOTransport(JobServiceTransport):
"""gRPC AsyncIO backend transport for JobService.
A service for creating and managing AI Platform's jobs.
This class defines the same methods as the primary client, so the
primary client can load the underlying transport implementation
and call it.
It sends protocol buffers over the wire using gRPC (which is built on
top of HTTP/2); the ``grpcio`` package must be installed.
"""
_grpc_channel: aio.Channel
_stubs: Dict[str, Callable] = {}
@classmethod
def create_channel(
cls,
host: str = "aiplatform.googleapis.com",
credentials: credentials.Credentials = None,
credentials_file: Optional[str] = None,
scopes: Optional[Sequence[str]] = None,
quota_project_id: Optional[str] = None,
**kwargs,
) -> aio.Channel:
"""Create and return a gRPC AsyncIO channel object.
Args:
address (Optional[str]): The host for the channel to use.
credentials (Optional[~.Credentials]): The
authorization credentials to attach to requests. These
credentials identify this application to the service. If
none are specified, the client will attempt to ascertain
the credentials from the environment.
credentials_file (Optional[str]): A file with credentials that can
be loaded with :func:`google.auth.load_credentials_from_file`.
This argument is ignored if ``channel`` is provided.
scopes (Optional[Sequence[str]]): A optional list of scopes needed for this
service. These are only used when credentials are not specified and
are passed to :func:`google.auth.default`.
quota_project_id (Optional[str]): An optional project to use for billing
and quota.
kwargs (Optional[dict]): Keyword arguments, which are passed to the
channel creation.
Returns:
aio.Channel: A gRPC AsyncIO channel object.
"""
scopes = scopes or cls.AUTH_SCOPES
return grpc_helpers_async.create_channel(
host,
credentials=credentials,
credentials_file=credentials_file,
scopes=scopes,
quota_project_id=quota_project_id,
**kwargs,
)
def __init__(
self,
*,
host: str = "aiplatform.googleapis.com",
credentials: credentials.Credentials = None,
credentials_file: Optional[str] = None,
scopes: Optional[Sequence[str]] = None,
channel: aio.Channel = None,
api_mtls_endpoint: str = None,
client_cert_source: Callable[[], Tuple[bytes, bytes]] = None,
ssl_channel_credentials: grpc.ChannelCredentials = None,
quota_project_id=None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
) -> None:
"""Instantiate the transport.
Args:
host (Optional[str]): The hostname to connect to.
credentials (Optional[google.auth.credentials.Credentials]): The
authorization credentials to attach to requests. These
credentials identify the application to the service; if none
are specified, the client will attempt to ascertain the
credentials from the environment.
This argument is ignored if ``channel`` is provided.
credentials_file (Optional[str]): A file with credentials that can
be loaded with :func:`google.auth.load_credentials_from_file`.
This argument is ignored if ``channel`` is provided.
scopes (Optional[Sequence[str]]): A optional list of scopes needed for this
service. These are only used when credentials are not specified and
are passed to :func:`google.auth.default`.
channel (Optional[aio.Channel]): A ``Channel`` instance through
which to make calls.
api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint.
If provided, it overrides the ``host`` argument and tries to create
a mutual TLS channel with client SSL credentials from
``client_cert_source`` or applicatin default SSL credentials.
client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]):
Deprecated. A callback to provide client SSL certificate bytes and
private key bytes, both in PEM format. It is ignored if
``api_mtls_endpoint`` is None.
ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials
for grpc channel. It is ignored if ``channel`` is provided.
quota_project_id (Optional[str]): An optional project to use for billing
and quota.
client_info (google.api_core.gapic_v1.client_info.ClientInfo):
The client info used to send a user-agent string along with
API requests. If ``None``, then default info will be used.
Generally, you only need to set this if you're developing
your own client library.
Raises:
google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport
creation failed for any reason.
google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials``
and ``credentials_file`` are passed.
"""
self._ssl_channel_credentials = ssl_channel_credentials
if channel:
# Sanity check: Ensure that channel and credentials are not both
# provided.
credentials = False
# If a channel was explicitly provided, set it.
self._grpc_channel = channel
self._ssl_channel_credentials = None
elif api_mtls_endpoint:
warnings.warn(
"api_mtls_endpoint and client_cert_source are deprecated",
DeprecationWarning,
)
host = (
api_mtls_endpoint
if ":" in api_mtls_endpoint
else api_mtls_endpoint + ":443"
)
if credentials is None:
credentials, _ = auth.default(
scopes=self.AUTH_SCOPES, quota_project_id=quota_project_id
)
# Create SSL credentials with client_cert_source or application
# default SSL credentials.
if client_cert_source:
cert, key = client_cert_source()
ssl_credentials = grpc.ssl_channel_credentials(
certificate_chain=cert, private_key=key
)
else:
ssl_credentials = SslCredentials().ssl_credentials
# create a new channel. The provided one is ignored.
self._grpc_channel = type(self).create_channel(
host,
credentials=credentials,
credentials_file=credentials_file,
ssl_credentials=ssl_credentials,
scopes=scopes or self.AUTH_SCOPES,
quota_project_id=quota_project_id,
)
self._ssl_channel_credentials = ssl_credentials
else:
host = host if ":" in host else host + ":443"
if credentials is None:
credentials, _ = auth.default(
scopes=self.AUTH_SCOPES, quota_project_id=quota_project_id
)
# create a new channel. The provided one is ignored.
self._grpc_channel = type(self).create_channel(
host,
credentials=credentials,
credentials_file=credentials_file,
ssl_credentials=ssl_channel_credentials,
scopes=scopes or self.AUTH_SCOPES,
quota_project_id=quota_project_id,
)
# Run the base constructor.
super().__init__(
host=host,
credentials=credentials,
credentials_file=credentials_file,
scopes=scopes or self.AUTH_SCOPES,
quota_project_id=quota_project_id,
client_info=client_info,
)
self._stubs = {}
@property
def grpc_channel(self) -> aio.Channel:
"""Create the channel designed to connect to this service.
This property caches on the instance; repeated calls return
the same channel.
"""
# Return the channel from cache.
return self._grpc_channel
@property
def operations_client(self) -> operations_v1.OperationsAsyncClient:
"""Create the client designed to process long-running operations.
This property caches on the instance; repeated calls return the same
client.
"""
# Sanity check: Only create a new client if we do not already have one.
if "operations_client" not in self.__dict__:
self.__dict__["operations_client"] = operations_v1.OperationsAsyncClient(
self.grpc_channel
)
# Return the client from cache.
return self.__dict__["operations_client"]
@property
def create_custom_job(
self,
) -> Callable[
[job_service.CreateCustomJobRequest], Awaitable[gca_custom_job.CustomJob]
]:
r"""Return a callable for the create custom job method over gRPC.
Creates a CustomJob. A created CustomJob right away
will be attempted to be run.
Returns:
Callable[[~.CreateCustomJobRequest],
Awaitable[~.CustomJob]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "create_custom_job" not in self._stubs:
self._stubs["create_custom_job"] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/CreateCustomJob",
request_serializer=job_service.CreateCustomJobRequest.serialize,
response_deserializer=gca_custom_job.CustomJob.deserialize,
)
return self._stubs["create_custom_job"]
@property
def get_custom_job(
self,
) -> Callable[[job_service.GetCustomJobRequest], Awaitable[custom_job.CustomJob]]:
r"""Return a callable for the get custom job method over gRPC.
Gets a CustomJob.
Returns:
Callable[[~.GetCustomJobRequest],
Awaitable[~.CustomJob]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "get_custom_job" not in self._stubs:
self._stubs["get_custom_job"] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/GetCustomJob",
request_serializer=job_service.GetCustomJobRequest.serialize,
response_deserializer=custom_job.CustomJob.deserialize,
)
return self._stubs["get_custom_job"]
@property
def list_custom_jobs(
self,
) -> Callable[
[job_service.ListCustomJobsRequest],
Awaitable[job_service.ListCustomJobsResponse],
]:
r"""Return a callable for the list custom jobs method over gRPC.
Lists CustomJobs in a Location.
Returns:
Callable[[~.ListCustomJobsRequest],
Awaitable[~.ListCustomJobsResponse]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "list_custom_jobs" not in self._stubs:
self._stubs["list_custom_jobs"] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/ListCustomJobs",
request_serializer=job_service.ListCustomJobsRequest.serialize,
response_deserializer=job_service.ListCustomJobsResponse.deserialize,
)
return self._stubs["list_custom_jobs"]
@property
def delete_custom_job(
self,
) -> Callable[
[job_service.DeleteCustomJobRequest], Awaitable[operations.Operation]
]:
r"""Return a callable for the delete custom job method over gRPC.
Deletes a CustomJob.
Returns:
Callable[[~.DeleteCustomJobRequest],
Awaitable[~.Operation]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "delete_custom_job" not in self._stubs:
self._stubs["delete_custom_job"] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/DeleteCustomJob",
request_serializer=job_service.DeleteCustomJobRequest.serialize,
response_deserializer=operations.Operation.FromString,
)
return self._stubs["delete_custom_job"]
@property
def cancel_custom_job(
self,
) -> Callable[[job_service.CancelCustomJobRequest], Awaitable[empty.Empty]]:
r"""Return a callable for the cancel custom job method over gRPC.
Cancels a CustomJob. Starts asynchronous cancellation on the
CustomJob. The server makes a best effort to cancel the job, but
success is not guaranteed. Clients can use
``JobService.GetCustomJob``
or other methods to check whether the cancellation succeeded or
whether the job completed despite cancellation. On successful
cancellation, the CustomJob is not deleted; instead it becomes a
job with a
``CustomJob.error``
value with a ``google.rpc.Status.code`` of
1, corresponding to ``Code.CANCELLED``, and
``CustomJob.state``
is set to ``CANCELLED``.
Returns:
Callable[[~.CancelCustomJobRequest],
Awaitable[~.Empty]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "cancel_custom_job" not in self._stubs:
self._stubs["cancel_custom_job"] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/CancelCustomJob",
request_serializer=job_service.CancelCustomJobRequest.serialize,
response_deserializer=empty.Empty.FromString,
)
return self._stubs["cancel_custom_job"]
@property
def create_data_labeling_job(
self,
) -> Callable[
[job_service.CreateDataLabelingJobRequest],
Awaitable[gca_data_labeling_job.DataLabelingJob],
]:
r"""Return a callable for the create data labeling job method over gRPC.
Creates a DataLabelingJob.
Returns:
Callable[[~.CreateDataLabelingJobRequest],
Awaitable[~.DataLabelingJob]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "create_data_labeling_job" not in self._stubs:
self._stubs["create_data_labeling_job"] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/CreateDataLabelingJob",
request_serializer=job_service.CreateDataLabelingJobRequest.serialize,
response_deserializer=gca_data_labeling_job.DataLabelingJob.deserialize,
)
return self._stubs["create_data_labeling_job"]
@property
def get_data_labeling_job(
self,
) -> Callable[
[job_service.GetDataLabelingJobRequest],
Awaitable[data_labeling_job.DataLabelingJob],
]:
r"""Return a callable for the get data labeling job method over gRPC.
Gets a DataLabelingJob.
Returns:
Callable[[~.GetDataLabelingJobRequest],
Awaitable[~.DataLabelingJob]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "get_data_labeling_job" not in self._stubs:
self._stubs["get_data_labeling_job"] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/GetDataLabelingJob",
request_serializer=job_service.GetDataLabelingJobRequest.serialize,
response_deserializer=data_labeling_job.DataLabelingJob.deserialize,
)
return self._stubs["get_data_labeling_job"]
@property
def list_data_labeling_jobs(
self,
) -> Callable[
[job_service.ListDataLabelingJobsRequest],
Awaitable[job_service.ListDataLabelingJobsResponse],
]:
r"""Return a callable for the list data labeling jobs method over gRPC.
Lists DataLabelingJobs in a Location.
Returns:
Callable[[~.ListDataLabelingJobsRequest],
Awaitable[~.ListDataLabelingJobsResponse]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "list_data_labeling_jobs" not in self._stubs:
self._stubs["list_data_labeling_jobs"] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/ListDataLabelingJobs",
request_serializer=job_service.ListDataLabelingJobsRequest.serialize,
response_deserializer=job_service.ListDataLabelingJobsResponse.deserialize,
)
return self._stubs["list_data_labeling_jobs"]
@property
def delete_data_labeling_job(
self,
) -> Callable[
[job_service.DeleteDataLabelingJobRequest], Awaitable[operations.Operation]
]:
r"""Return a callable for the delete data labeling job method over gRPC.
Deletes a DataLabelingJob.
Returns:
Callable[[~.DeleteDataLabelingJobRequest],
Awaitable[~.Operation]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "delete_data_labeling_job" not in self._stubs:
self._stubs["delete_data_labeling_job"] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/DeleteDataLabelingJob",
request_serializer=job_service.DeleteDataLabelingJobRequest.serialize,
response_deserializer=operations.Operation.FromString,
)
return self._stubs["delete_data_labeling_job"]
@property
def cancel_data_labeling_job(
self,
) -> Callable[[job_service.CancelDataLabelingJobRequest], Awaitable[empty.Empty]]:
r"""Return a callable for the cancel data labeling job method over gRPC.
Cancels a DataLabelingJob. Success of cancellation is
not guaranteed.
Returns:
Callable[[~.CancelDataLabelingJobRequest],
Awaitable[~.Empty]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "cancel_data_labeling_job" not in self._stubs:
self._stubs["cancel_data_labeling_job"] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/CancelDataLabelingJob",
request_serializer=job_service.CancelDataLabelingJobRequest.serialize,
response_deserializer=empty.Empty.FromString,
)
return self._stubs["cancel_data_labeling_job"]
@property
def create_hyperparameter_tuning_job(
self,
) -> Callable[
[job_service.CreateHyperparameterTuningJobRequest],
Awaitable[gca_hyperparameter_tuning_job.HyperparameterTuningJob],
]:
r"""Return a callable for the create hyperparameter tuning
job method over gRPC.
Creates a HyperparameterTuningJob
Returns:
Callable[[~.CreateHyperparameterTuningJobRequest],
Awaitable[~.HyperparameterTuningJob]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "create_hyperparameter_tuning_job" not in self._stubs:
self._stubs[
"create_hyperparameter_tuning_job"
] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/CreateHyperparameterTuningJob",
request_serializer=job_service.CreateHyperparameterTuningJobRequest.serialize,
response_deserializer=gca_hyperparameter_tuning_job.HyperparameterTuningJob.deserialize,
)
return self._stubs["create_hyperparameter_tuning_job"]
@property
def get_hyperparameter_tuning_job(
self,
) -> Callable[
[job_service.GetHyperparameterTuningJobRequest],
Awaitable[hyperparameter_tuning_job.HyperparameterTuningJob],
]:
r"""Return a callable for the get hyperparameter tuning job method over gRPC.
Gets a HyperparameterTuningJob
Returns:
Callable[[~.GetHyperparameterTuningJobRequest],
Awaitable[~.HyperparameterTuningJob]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "get_hyperparameter_tuning_job" not in self._stubs:
self._stubs[
"get_hyperparameter_tuning_job"
] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/GetHyperparameterTuningJob",
request_serializer=job_service.GetHyperparameterTuningJobRequest.serialize,
response_deserializer=hyperparameter_tuning_job.HyperparameterTuningJob.deserialize,
)
return self._stubs["get_hyperparameter_tuning_job"]
@property
def list_hyperparameter_tuning_jobs(
self,
) -> Callable[
[job_service.ListHyperparameterTuningJobsRequest],
Awaitable[job_service.ListHyperparameterTuningJobsResponse],
]:
r"""Return a callable for the list hyperparameter tuning
jobs method over gRPC.
Lists HyperparameterTuningJobs in a Location.
Returns:
Callable[[~.ListHyperparameterTuningJobsRequest],
Awaitable[~.ListHyperparameterTuningJobsResponse]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "list_hyperparameter_tuning_jobs" not in self._stubs:
self._stubs[
"list_hyperparameter_tuning_jobs"
] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/ListHyperparameterTuningJobs",
request_serializer=job_service.ListHyperparameterTuningJobsRequest.serialize,
response_deserializer=job_service.ListHyperparameterTuningJobsResponse.deserialize,
)
return self._stubs["list_hyperparameter_tuning_jobs"]
@property
def delete_hyperparameter_tuning_job(
self,
) -> Callable[
[job_service.DeleteHyperparameterTuningJobRequest],
Awaitable[operations.Operation],
]:
r"""Return a callable for the delete hyperparameter tuning
job method over gRPC.
Deletes a HyperparameterTuningJob.
Returns:
Callable[[~.DeleteHyperparameterTuningJobRequest],
Awaitable[~.Operation]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "delete_hyperparameter_tuning_job" not in self._stubs:
self._stubs[
"delete_hyperparameter_tuning_job"
] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/DeleteHyperparameterTuningJob",
request_serializer=job_service.DeleteHyperparameterTuningJobRequest.serialize,
response_deserializer=operations.Operation.FromString,
)
return self._stubs["delete_hyperparameter_tuning_job"]
@property
def cancel_hyperparameter_tuning_job(
self,
) -> Callable[
[job_service.CancelHyperparameterTuningJobRequest], Awaitable[empty.Empty]
]:
r"""Return a callable for the cancel hyperparameter tuning
job method over gRPC.
Cancels a HyperparameterTuningJob. Starts asynchronous
cancellation on the HyperparameterTuningJob. The server makes a
best effort to cancel the job, but success is not guaranteed.
Clients can use
``JobService.GetHyperparameterTuningJob``
or other methods to check whether the cancellation succeeded or
whether the job completed despite cancellation. On successful
cancellation, the HyperparameterTuningJob is not deleted;
instead it becomes a job with a
``HyperparameterTuningJob.error``
value with a ``google.rpc.Status.code`` of
1, corresponding to ``Code.CANCELLED``, and
``HyperparameterTuningJob.state``
is set to ``CANCELLED``.
Returns:
Callable[[~.CancelHyperparameterTuningJobRequest],
Awaitable[~.Empty]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "cancel_hyperparameter_tuning_job" not in self._stubs:
self._stubs[
"cancel_hyperparameter_tuning_job"
] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/CancelHyperparameterTuningJob",
request_serializer=job_service.CancelHyperparameterTuningJobRequest.serialize,
response_deserializer=empty.Empty.FromString,
)
return self._stubs["cancel_hyperparameter_tuning_job"]
@property
def create_batch_prediction_job(
self,
) -> Callable[
[job_service.CreateBatchPredictionJobRequest],
Awaitable[gca_batch_prediction_job.BatchPredictionJob],
]:
r"""Return a callable for the create batch prediction job method over gRPC.
Creates a BatchPredictionJob. A BatchPredictionJob
once created will right away be attempted to start.
Returns:
Callable[[~.CreateBatchPredictionJobRequest],
Awaitable[~.BatchPredictionJob]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "create_batch_prediction_job" not in self._stubs:
self._stubs["create_batch_prediction_job"] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/CreateBatchPredictionJob",
request_serializer=job_service.CreateBatchPredictionJobRequest.serialize,
response_deserializer=gca_batch_prediction_job.BatchPredictionJob.deserialize,
)
return self._stubs["create_batch_prediction_job"]
@property
def get_batch_prediction_job(
self,
) -> Callable[
[job_service.GetBatchPredictionJobRequest],
Awaitable[batch_prediction_job.BatchPredictionJob],
]:
r"""Return a callable for the get batch prediction job method over gRPC.
Gets a BatchPredictionJob
Returns:
Callable[[~.GetBatchPredictionJobRequest],
Awaitable[~.BatchPredictionJob]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "get_batch_prediction_job" not in self._stubs:
self._stubs["get_batch_prediction_job"] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/GetBatchPredictionJob",
request_serializer=job_service.GetBatchPredictionJobRequest.serialize,
response_deserializer=batch_prediction_job.BatchPredictionJob.deserialize,
)
return self._stubs["get_batch_prediction_job"]
@property
def list_batch_prediction_jobs(
self,
) -> Callable[
[job_service.ListBatchPredictionJobsRequest],
Awaitable[job_service.ListBatchPredictionJobsResponse],
]:
r"""Return a callable for the list batch prediction jobs method over gRPC.
Lists BatchPredictionJobs in a Location.
Returns:
Callable[[~.ListBatchPredictionJobsRequest],
Awaitable[~.ListBatchPredictionJobsResponse]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "list_batch_prediction_jobs" not in self._stubs:
self._stubs["list_batch_prediction_jobs"] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/ListBatchPredictionJobs",
request_serializer=job_service.ListBatchPredictionJobsRequest.serialize,
response_deserializer=job_service.ListBatchPredictionJobsResponse.deserialize,
)
return self._stubs["list_batch_prediction_jobs"]
@property
def delete_batch_prediction_job(
self,
) -> Callable[
[job_service.DeleteBatchPredictionJobRequest], Awaitable[operations.Operation]
]:
r"""Return a callable for the delete batch prediction job method over gRPC.
Deletes a BatchPredictionJob. Can only be called on
jobs that already finished.
Returns:
Callable[[~.DeleteBatchPredictionJobRequest],
Awaitable[~.Operation]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "delete_batch_prediction_job" not in self._stubs:
self._stubs["delete_batch_prediction_job"] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/DeleteBatchPredictionJob",
request_serializer=job_service.DeleteBatchPredictionJobRequest.serialize,
response_deserializer=operations.Operation.FromString,
)
return self._stubs["delete_batch_prediction_job"]
@property
def cancel_batch_prediction_job(
self,
) -> Callable[
[job_service.CancelBatchPredictionJobRequest], Awaitable[empty.Empty]
]:
r"""Return a callable for the cancel batch prediction job method over gRPC.
Cancels a BatchPredictionJob.
Starts asynchronous cancellation on the BatchPredictionJob. The
server makes the best effort to cancel the job, but success is
not guaranteed. Clients can use
``JobService.GetBatchPredictionJob``
or other methods to check whether the cancellation succeeded or
whether the job completed despite cancellation. On a successful
cancellation, the BatchPredictionJob is not deleted;instead its
``BatchPredictionJob.state``
is set to ``CANCELLED``. Any files already outputted by the job
are not deleted.
Returns:
Callable[[~.CancelBatchPredictionJobRequest],
Awaitable[~.Empty]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "cancel_batch_prediction_job" not in self._stubs:
self._stubs["cancel_batch_prediction_job"] = self.grpc_channel.unary_unary(
"/google.cloud.aiplatform.v1beta1.JobService/CancelBatchPredictionJob",
request_serializer=job_service.CancelBatchPredictionJobRequest.serialize,
response_deserializer=empty.Empty.FromString,
)
return self._stubs["cancel_batch_prediction_job"]
__all__ = ("JobServiceGrpcAsyncIOTransport",)