Skip to content
This repository was archived by the owner on Sep 29, 2023. It is now read-only.

Commit 7bbaafb

Browse files
feat: add default retry configuration (#123)
- [ ] Regenerate this pull request now. feat: add DeleteTransferJob operation feat: add AWS S3 compatible data source PiperOrigin-RevId: 473348271 Source-Link: googleapis/googleapis@56f2049 Source-Link: https://github.com/googleapis/googleapis-gen/commit/4f0ba4ff11c129006f76be68465f8e68a4a32814 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNGYwYmE0ZmYxMWMxMjkwMDZmNzZiZTY4NDY1ZjhlNjhhNGEzMjgxNCJ9
1 parent b716383 commit 7bbaafb

File tree

16 files changed

+803
-5
lines changed

16 files changed

+803
-5
lines changed

google/cloud/storage_transfer/__init__.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
CreateAgentPoolRequest,
2525
CreateTransferJobRequest,
2626
DeleteAgentPoolRequest,
27+
DeleteTransferJobRequest,
2728
GetAgentPoolRequest,
2829
GetGoogleServiceAccountRequest,
2930
GetTransferJobRequest,
@@ -40,6 +41,7 @@
4041
from google.cloud.storage_transfer_v1.types.transfer_types import (
4142
AgentPool,
4243
AwsAccessKey,
44+
AwsS3CompatibleData,
4345
AwsS3Data,
4446
AzureBlobStorageData,
4547
AzureCredentials,
@@ -53,6 +55,7 @@
5355
NotificationConfig,
5456
ObjectConditions,
5557
PosixFilesystem,
58+
S3CompatibleMetadata,
5659
Schedule,
5760
TransferCounters,
5861
TransferJob,
@@ -68,6 +71,7 @@
6871
"CreateAgentPoolRequest",
6972
"CreateTransferJobRequest",
7073
"DeleteAgentPoolRequest",
74+
"DeleteTransferJobRequest",
7175
"GetAgentPoolRequest",
7276
"GetGoogleServiceAccountRequest",
7377
"GetTransferJobRequest",
@@ -82,6 +86,7 @@
8286
"UpdateTransferJobRequest",
8387
"AgentPool",
8488
"AwsAccessKey",
89+
"AwsS3CompatibleData",
8590
"AwsS3Data",
8691
"AzureBlobStorageData",
8792
"AzureCredentials",
@@ -95,6 +100,7 @@
95100
"NotificationConfig",
96101
"ObjectConditions",
97102
"PosixFilesystem",
103+
"S3CompatibleMetadata",
98104
"Schedule",
99105
"TransferCounters",
100106
"TransferJob",

google/cloud/storage_transfer_v1/__init__.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
CreateAgentPoolRequest,
2323
CreateTransferJobRequest,
2424
DeleteAgentPoolRequest,
25+
DeleteTransferJobRequest,
2526
GetAgentPoolRequest,
2627
GetGoogleServiceAccountRequest,
2728
GetTransferJobRequest,
@@ -38,6 +39,7 @@
3839
from .types.transfer_types import (
3940
AgentPool,
4041
AwsAccessKey,
42+
AwsS3CompatibleData,
4143
AwsS3Data,
4244
AzureBlobStorageData,
4345
AzureCredentials,
@@ -51,6 +53,7 @@
5153
NotificationConfig,
5254
ObjectConditions,
5355
PosixFilesystem,
56+
S3CompatibleMetadata,
5457
Schedule,
5558
TransferCounters,
5659
TransferJob,
@@ -64,12 +67,14 @@
6467
"StorageTransferServiceAsyncClient",
6568
"AgentPool",
6669
"AwsAccessKey",
70+
"AwsS3CompatibleData",
6771
"AwsS3Data",
6872
"AzureBlobStorageData",
6973
"AzureCredentials",
7074
"CreateAgentPoolRequest",
7175
"CreateTransferJobRequest",
7276
"DeleteAgentPoolRequest",
77+
"DeleteTransferJobRequest",
7378
"ErrorLogEntry",
7479
"ErrorSummary",
7580
"GcsData",
@@ -90,6 +95,7 @@
9095
"PosixFilesystem",
9196
"ResumeTransferOperationRequest",
9297
"RunTransferJobRequest",
98+
"S3CompatibleMetadata",
9399
"Schedule",
94100
"StorageTransferServiceClient",
95101
"TransferCounters",

google/cloud/storage_transfer_v1/gapic_metadata.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@
2525
"delete_agent_pool"
2626
]
2727
},
28+
"DeleteTransferJob": {
29+
"methods": [
30+
"delete_transfer_job"
31+
]
32+
},
2833
"GetAgentPool": {
2934
"methods": [
3035
"get_agent_pool"
@@ -95,6 +100,11 @@
95100
"delete_agent_pool"
96101
]
97102
},
103+
"DeleteTransferJob": {
104+
"methods": [
105+
"delete_transfer_job"
106+
]
107+
},
98108
"GetAgentPool": {
99109
"methods": [
100110
"get_agent_pool"

google/cloud/storage_transfer_v1/services/storage_transfer_service/async_client.py

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,7 @@ async def sample_create_transfer_job():
364364
# and friendly error handling.
365365
rpc = gapic_v1.method_async.wrap_method(
366366
self._client._transport.create_transfer_job,
367-
default_timeout=None,
367+
default_timeout=60.0,
368368
client_info=DEFAULT_CLIENT_INFO,
369369
)
370370

@@ -880,6 +880,76 @@ async def sample_run_transfer_job():
880880
# Done; return the response.
881881
return response
882882

883+
async def delete_transfer_job(
884+
self,
885+
request: Union[transfer.DeleteTransferJobRequest, dict] = None,
886+
*,
887+
retry: OptionalRetry = gapic_v1.method.DEFAULT,
888+
timeout: float = None,
889+
metadata: Sequence[Tuple[str, str]] = (),
890+
) -> None:
891+
r"""Deletes a transfer job. Deleting a transfer job sets its status
892+
to
893+
[DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED].
894+
895+
.. code-block:: python
896+
897+
# This snippet has been automatically generated and should be regarded as a
898+
# code template only.
899+
# It will require modifications to work:
900+
# - It may require correct/in-range values for request initialization.
901+
# - It may require specifying regional endpoints when creating the service
902+
# client as shown in:
903+
# https://googleapis.dev/python/google-api-core/latest/client_options.html
904+
from google.cloud import storage_transfer_v1
905+
906+
async def sample_delete_transfer_job():
907+
# Create a client
908+
client = storage_transfer_v1.StorageTransferServiceAsyncClient()
909+
910+
# Initialize request argument(s)
911+
request = storage_transfer_v1.DeleteTransferJobRequest(
912+
job_name="job_name_value",
913+
project_id="project_id_value",
914+
)
915+
916+
# Make the request
917+
await client.delete_transfer_job(request=request)
918+
919+
Args:
920+
request (Union[google.cloud.storage_transfer_v1.types.DeleteTransferJobRequest, dict]):
921+
The request object. Request passed to DeleteTransferJob.
922+
retry (google.api_core.retry.Retry): Designation of what errors, if any,
923+
should be retried.
924+
timeout (float): The timeout for this request.
925+
metadata (Sequence[Tuple[str, str]]): Strings which should be
926+
sent along with the request as metadata.
927+
"""
928+
# Create or coerce a protobuf request object.
929+
request = transfer.DeleteTransferJobRequest(request)
930+
931+
# Wrap the RPC method; this adds retry and timeout information,
932+
# and friendly error handling.
933+
rpc = gapic_v1.method_async.wrap_method(
934+
self._client._transport.delete_transfer_job,
935+
default_timeout=None,
936+
client_info=DEFAULT_CLIENT_INFO,
937+
)
938+
939+
# Certain fields should be provided within the metadata header;
940+
# add these here.
941+
metadata = tuple(metadata) + (
942+
gapic_v1.routing_header.to_grpc_metadata((("job_name", request.job_name),)),
943+
)
944+
945+
# Send the request.
946+
await rpc(
947+
request,
948+
retry=retry,
949+
timeout=timeout,
950+
metadata=metadata,
951+
)
952+
883953
async def create_agent_pool(
884954
self,
885955
request: Union[transfer.CreateAgentPoolRequest, dict] = None,

google/cloud/storage_transfer_v1/services/storage_transfer_service/client.py

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1109,6 +1109,77 @@ def sample_run_transfer_job():
11091109
# Done; return the response.
11101110
return response
11111111

1112+
def delete_transfer_job(
1113+
self,
1114+
request: Union[transfer.DeleteTransferJobRequest, dict] = None,
1115+
*,
1116+
retry: OptionalRetry = gapic_v1.method.DEFAULT,
1117+
timeout: float = None,
1118+
metadata: Sequence[Tuple[str, str]] = (),
1119+
) -> None:
1120+
r"""Deletes a transfer job. Deleting a transfer job sets its status
1121+
to
1122+
[DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED].
1123+
1124+
.. code-block:: python
1125+
1126+
# This snippet has been automatically generated and should be regarded as a
1127+
# code template only.
1128+
# It will require modifications to work:
1129+
# - It may require correct/in-range values for request initialization.
1130+
# - It may require specifying regional endpoints when creating the service
1131+
# client as shown in:
1132+
# https://googleapis.dev/python/google-api-core/latest/client_options.html
1133+
from google.cloud import storage_transfer_v1
1134+
1135+
def sample_delete_transfer_job():
1136+
# Create a client
1137+
client = storage_transfer_v1.StorageTransferServiceClient()
1138+
1139+
# Initialize request argument(s)
1140+
request = storage_transfer_v1.DeleteTransferJobRequest(
1141+
job_name="job_name_value",
1142+
project_id="project_id_value",
1143+
)
1144+
1145+
# Make the request
1146+
client.delete_transfer_job(request=request)
1147+
1148+
Args:
1149+
request (Union[google.cloud.storage_transfer_v1.types.DeleteTransferJobRequest, dict]):
1150+
The request object. Request passed to DeleteTransferJob.
1151+
retry (google.api_core.retry.Retry): Designation of what errors, if any,
1152+
should be retried.
1153+
timeout (float): The timeout for this request.
1154+
metadata (Sequence[Tuple[str, str]]): Strings which should be
1155+
sent along with the request as metadata.
1156+
"""
1157+
# Create or coerce a protobuf request object.
1158+
# Minor optimization to avoid making a copy if the user passes
1159+
# in a transfer.DeleteTransferJobRequest.
1160+
# There's no risk of modifying the input as we've already verified
1161+
# there are no flattened fields.
1162+
if not isinstance(request, transfer.DeleteTransferJobRequest):
1163+
request = transfer.DeleteTransferJobRequest(request)
1164+
1165+
# Wrap the RPC method; this adds retry and timeout information,
1166+
# and friendly error handling.
1167+
rpc = self._transport._wrapped_methods[self._transport.delete_transfer_job]
1168+
1169+
# Certain fields should be provided within the metadata header;
1170+
# add these here.
1171+
metadata = tuple(metadata) + (
1172+
gapic_v1.routing_header.to_grpc_metadata((("job_name", request.job_name),)),
1173+
)
1174+
1175+
# Send the request.
1176+
rpc(
1177+
request,
1178+
retry=retry,
1179+
timeout=timeout,
1180+
metadata=metadata,
1181+
)
1182+
11121183
def create_agent_pool(
11131184
self,
11141185
request: Union[transfer.CreateAgentPoolRequest, dict] = None,

google/cloud/storage_transfer_v1/services/storage_transfer_service/transports/base.py

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ def _prep_wrapped_messages(self, client_info):
136136
),
137137
self.create_transfer_job: gapic_v1.method.wrap_method(
138138
self.create_transfer_job,
139-
default_timeout=None,
139+
default_timeout=60.0,
140140
client_info=client_info,
141141
),
142142
self.update_transfer_job: gapic_v1.method.wrap_method(
@@ -169,6 +169,11 @@ def _prep_wrapped_messages(self, client_info):
169169
default_timeout=None,
170170
client_info=client_info,
171171
),
172+
self.delete_transfer_job: gapic_v1.method.wrap_method(
173+
self.delete_transfer_job,
174+
default_timeout=None,
175+
client_info=client_info,
176+
),
172177
self.create_agent_pool: gapic_v1.method.wrap_method(
173178
self.create_agent_pool,
174179
default_timeout=None,
@@ -288,6 +293,15 @@ def run_transfer_job(
288293
]:
289294
raise NotImplementedError()
290295

296+
@property
297+
def delete_transfer_job(
298+
self,
299+
) -> Callable[
300+
[transfer.DeleteTransferJobRequest],
301+
Union[empty_pb2.Empty, Awaitable[empty_pb2.Empty]],
302+
]:
303+
raise NotImplementedError()
304+
291305
@property
292306
def create_agent_pool(
293307
self,

google/cloud/storage_transfer_v1/services/storage_transfer_service/transports/grpc.py

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -482,6 +482,34 @@ def run_transfer_job(
482482
)
483483
return self._stubs["run_transfer_job"]
484484

485+
@property
486+
def delete_transfer_job(
487+
self,
488+
) -> Callable[[transfer.DeleteTransferJobRequest], empty_pb2.Empty]:
489+
r"""Return a callable for the delete transfer job method over gRPC.
490+
491+
Deletes a transfer job. Deleting a transfer job sets its status
492+
to
493+
[DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED].
494+
495+
Returns:
496+
Callable[[~.DeleteTransferJobRequest],
497+
~.Empty]:
498+
A function that, when called, will call the underlying RPC
499+
on the server.
500+
"""
501+
# Generate a "stub function" on-the-fly which will actually make
502+
# the request.
503+
# gRPC handles serialization and deserialization, so we just need
504+
# to pass in the functions for each.
505+
if "delete_transfer_job" not in self._stubs:
506+
self._stubs["delete_transfer_job"] = self.grpc_channel.unary_unary(
507+
"/google.storagetransfer.v1.StorageTransferService/DeleteTransferJob",
508+
request_serializer=transfer.DeleteTransferJobRequest.serialize,
509+
response_deserializer=empty_pb2.Empty.FromString,
510+
)
511+
return self._stubs["delete_transfer_job"]
512+
485513
@property
486514
def create_agent_pool(
487515
self,

google/cloud/storage_transfer_v1/services/storage_transfer_service/transports/grpc_asyncio.py

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -498,6 +498,34 @@ def run_transfer_job(
498498
)
499499
return self._stubs["run_transfer_job"]
500500

501+
@property
502+
def delete_transfer_job(
503+
self,
504+
) -> Callable[[transfer.DeleteTransferJobRequest], Awaitable[empty_pb2.Empty]]:
505+
r"""Return a callable for the delete transfer job method over gRPC.
506+
507+
Deletes a transfer job. Deleting a transfer job sets its status
508+
to
509+
[DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED].
510+
511+
Returns:
512+
Callable[[~.DeleteTransferJobRequest],
513+
Awaitable[~.Empty]]:
514+
A function that, when called, will call the underlying RPC
515+
on the server.
516+
"""
517+
# Generate a "stub function" on-the-fly which will actually make
518+
# the request.
519+
# gRPC handles serialization and deserialization, so we just need
520+
# to pass in the functions for each.
521+
if "delete_transfer_job" not in self._stubs:
522+
self._stubs["delete_transfer_job"] = self.grpc_channel.unary_unary(
523+
"/google.storagetransfer.v1.StorageTransferService/DeleteTransferJob",
524+
request_serializer=transfer.DeleteTransferJobRequest.serialize,
525+
response_deserializer=empty_pb2.Empty.FromString,
526+
)
527+
return self._stubs["delete_transfer_job"]
528+
501529
@property
502530
def create_agent_pool(
503531
self,

0 commit comments

Comments
 (0)