google-cloud-storage_transfer-v1 0.1.0 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +1 -1
- data/AUTHENTICATION.md +7 -25
- data/README.md +1 -1
- data/lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb +704 -43
- data/lib/google/cloud/storage_transfer/v1/storage_transfer_service/operations.rb +115 -12
- data/lib/google/cloud/storage_transfer/v1/storage_transfer_service/paths.rb +50 -0
- data/lib/google/cloud/storage_transfer/v1/storage_transfer_service.rb +1 -0
- data/lib/google/cloud/storage_transfer/v1/version.rb +1 -1
- data/lib/google/cloud/storage_transfer/v1.rb +2 -0
- data/lib/google/storagetransfer/v1/transfer_pb.rb +33 -3
- data/lib/google/storagetransfer/v1/transfer_services_pb.rb +15 -5
- data/lib/google/storagetransfer/v1/transfer_types_pb.rb +141 -4
- data/proto_docs/google/api/resource.rb +10 -71
- data/proto_docs/google/storagetransfer/v1/transfer.rb +129 -20
- data/proto_docs/google/storagetransfer/v1/transfer_types.rb +487 -113
- metadata +4 -3
@@ -33,11 +33,7 @@ module Google
|
|
33
33
|
# // For Kubernetes resources, the format is {api group}/{kind}.
|
34
34
|
# option (google.api.resource) = {
|
35
35
|
# type: "pubsub.googleapis.com/Topic"
|
36
|
-
#
|
37
|
-
# pattern: "projects/{project}/topics/{topic}"
|
38
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
39
|
-
# parent_name_extractor: "projects/{project}"
|
40
|
-
# }
|
36
|
+
# pattern: "projects/{project}/topics/{topic}"
|
41
37
|
# };
|
42
38
|
# }
|
43
39
|
#
|
@@ -45,10 +41,7 @@ module Google
|
|
45
41
|
#
|
46
42
|
# resources:
|
47
43
|
# - type: "pubsub.googleapis.com/Topic"
|
48
|
-
#
|
49
|
-
# - pattern: "projects/{project}/topics/{topic}"
|
50
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
51
|
-
# parent_name_extractor: "projects/{project}"
|
44
|
+
# pattern: "projects/{project}/topics/{topic}"
|
52
45
|
#
|
53
46
|
# Sometimes, resources have multiple patterns, typically because they can
|
54
47
|
# live under multiple parents.
|
@@ -58,26 +51,10 @@ module Google
|
|
58
51
|
# message LogEntry {
|
59
52
|
# option (google.api.resource) = {
|
60
53
|
# type: "logging.googleapis.com/LogEntry"
|
61
|
-
#
|
62
|
-
#
|
63
|
-
#
|
64
|
-
#
|
65
|
-
# }
|
66
|
-
# name_descriptor: {
|
67
|
-
# pattern: "folders/{folder}/logs/{log}"
|
68
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
69
|
-
# parent_name_extractor: "folders/{folder}"
|
70
|
-
# }
|
71
|
-
# name_descriptor: {
|
72
|
-
# pattern: "organizations/{organization}/logs/{log}"
|
73
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
74
|
-
# parent_name_extractor: "organizations/{organization}"
|
75
|
-
# }
|
76
|
-
# name_descriptor: {
|
77
|
-
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
78
|
-
# parent_type: "billing.googleapis.com/BillingAccount"
|
79
|
-
# parent_name_extractor: "billingAccounts/{billing_account}"
|
80
|
-
# }
|
54
|
+
# pattern: "projects/{project}/logs/{log}"
|
55
|
+
# pattern: "folders/{folder}/logs/{log}"
|
56
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
57
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
81
58
|
# };
|
82
59
|
# }
|
83
60
|
#
|
@@ -85,48 +62,10 @@ module Google
|
|
85
62
|
#
|
86
63
|
# resources:
|
87
64
|
# - type: 'logging.googleapis.com/LogEntry'
|
88
|
-
#
|
89
|
-
#
|
90
|
-
#
|
91
|
-
#
|
92
|
-
# - pattern: "folders/{folder}/logs/{log}"
|
93
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
94
|
-
# parent_name_extractor: "folders/{folder}"
|
95
|
-
# - pattern: "organizations/{organization}/logs/{log}"
|
96
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
97
|
-
# parent_name_extractor: "organizations/{organization}"
|
98
|
-
# - pattern: "billingAccounts/{billing_account}/logs/{log}"
|
99
|
-
# parent_type: "billing.googleapis.com/BillingAccount"
|
100
|
-
# parent_name_extractor: "billingAccounts/{billing_account}"
|
101
|
-
#
|
102
|
-
# For flexible resources, the resource name doesn't contain parent names, but
|
103
|
-
# the resource itself has parents for policy evaluation.
|
104
|
-
#
|
105
|
-
# Example:
|
106
|
-
#
|
107
|
-
# message Shelf {
|
108
|
-
# option (google.api.resource) = {
|
109
|
-
# type: "library.googleapis.com/Shelf"
|
110
|
-
# name_descriptor: {
|
111
|
-
# pattern: "shelves/{shelf}"
|
112
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
113
|
-
# }
|
114
|
-
# name_descriptor: {
|
115
|
-
# pattern: "shelves/{shelf}"
|
116
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
117
|
-
# }
|
118
|
-
# };
|
119
|
-
# }
|
120
|
-
#
|
121
|
-
# The ResourceDescriptor Yaml config will look like:
|
122
|
-
#
|
123
|
-
# resources:
|
124
|
-
# - type: 'library.googleapis.com/Shelf'
|
125
|
-
# name_descriptor:
|
126
|
-
# - pattern: "shelves/{shelf}"
|
127
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
128
|
-
# - pattern: "shelves/{shelf}"
|
129
|
-
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
65
|
+
# pattern: "projects/{project}/logs/{log}"
|
66
|
+
# pattern: "folders/{folder}/logs/{log}"
|
67
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
68
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
130
69
|
# @!attribute [rw] type
|
131
70
|
# @return [::String]
|
132
71
|
# The resource type. It must be in the format of
|
@@ -24,8 +24,8 @@ module Google
|
|
24
24
|
# Request passed to GetGoogleServiceAccount.
|
25
25
|
# @!attribute [rw] project_id
|
26
26
|
# @return [::String]
|
27
|
-
# Required. The ID of the Google Cloud
|
28
|
-
#
|
27
|
+
# Required. The ID of the Google Cloud project that the Google service
|
28
|
+
# account is associated with.
|
29
29
|
class GetGoogleServiceAccountRequest
|
30
30
|
include ::Google::Protobuf::MessageExts
|
31
31
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -46,20 +46,19 @@ module Google
|
|
46
46
|
# Required. The name of job to update.
|
47
47
|
# @!attribute [rw] project_id
|
48
48
|
# @return [::String]
|
49
|
-
# Required. The ID of the Google Cloud
|
49
|
+
# Required. The ID of the Google Cloud project that owns the
|
50
50
|
# job.
|
51
51
|
# @!attribute [rw] transfer_job
|
52
52
|
# @return [::Google::Cloud::StorageTransfer::V1::TransferJob]
|
53
|
-
# Required. The job to update. `transferJob` is expected to specify
|
54
|
-
#
|
55
|
-
# {::Google::Cloud::StorageTransfer::V1::TransferJob#description description},
|
53
|
+
# Required. The job to update. `transferJob` is expected to specify one or more of
|
54
|
+
# five fields: {::Google::Cloud::StorageTransfer::V1::TransferJob#description description},
|
56
55
|
# {::Google::Cloud::StorageTransfer::V1::TransferJob#transfer_spec transfer_spec},
|
57
56
|
# {::Google::Cloud::StorageTransfer::V1::TransferJob#notification_config notification_config},
|
58
|
-
#
|
59
|
-
# `UpdateTransferJobRequest` that specifies
|
60
|
-
#
|
61
|
-
# job status
|
62
|
-
# {::Google::Cloud::StorageTransfer::V1::TransferJob::Status::DELETED DELETED} requires
|
57
|
+
# {::Google::Cloud::StorageTransfer::V1::TransferJob#logging_config logging_config}, and
|
58
|
+
# {::Google::Cloud::StorageTransfer::V1::TransferJob#status status}. An `UpdateTransferJobRequest` that specifies
|
59
|
+
# other fields are rejected with the error
|
60
|
+
# {::Google::Rpc::Code::INVALID_ARGUMENT INVALID_ARGUMENT}. Updating a job status
|
61
|
+
# to {::Google::Cloud::StorageTransfer::V1::TransferJob::Status::DELETED DELETED} requires
|
63
62
|
# `storagetransfer.jobs.delete` permissions.
|
64
63
|
# @!attribute [rw] update_transfer_job_field_mask
|
65
64
|
# @return [::Google::Protobuf::FieldMask]
|
@@ -68,10 +67,10 @@ module Google
|
|
68
67
|
# {::Google::Cloud::StorageTransfer::V1::TransferJob#description description},
|
69
68
|
# {::Google::Cloud::StorageTransfer::V1::TransferJob#transfer_spec transfer_spec},
|
70
69
|
# {::Google::Cloud::StorageTransfer::V1::TransferJob#notification_config notification_config},
|
71
|
-
#
|
72
|
-
# `transfer_spec` of the job, a
|
73
|
-
#
|
74
|
-
# rejected with the error
|
70
|
+
# {::Google::Cloud::StorageTransfer::V1::TransferJob#logging_config logging_config}, and
|
71
|
+
# {::Google::Cloud::StorageTransfer::V1::TransferJob#status status}. To update the `transfer_spec` of the job, a
|
72
|
+
# complete transfer specification must be provided. An incomplete
|
73
|
+
# specification missing any required fields is rejected with the error
|
75
74
|
# {::Google::Rpc::Code::INVALID_ARGUMENT INVALID_ARGUMENT}.
|
76
75
|
class UpdateTransferJobRequest
|
77
76
|
include ::Google::Protobuf::MessageExts
|
@@ -81,11 +80,10 @@ module Google
|
|
81
80
|
# Request passed to GetTransferJob.
|
82
81
|
# @!attribute [rw] job_name
|
83
82
|
# @return [::String]
|
84
|
-
# Required.
|
85
|
-
# The job to get.
|
83
|
+
# Required. The job to get.
|
86
84
|
# @!attribute [rw] project_id
|
87
85
|
# @return [::String]
|
88
|
-
# Required. The ID of the Google Cloud
|
86
|
+
# Required. The ID of the Google Cloud project that owns the
|
89
87
|
# job.
|
90
88
|
class GetTransferJobRequest
|
91
89
|
include ::Google::Protobuf::MessageExts
|
@@ -155,12 +153,123 @@ module Google
|
|
155
153
|
# Required. The name of the transfer job.
|
156
154
|
# @!attribute [rw] project_id
|
157
155
|
# @return [::String]
|
158
|
-
# Required. The ID of the Google Cloud
|
159
|
-
#
|
156
|
+
# Required. The ID of the Google Cloud project that owns the transfer
|
157
|
+
# job.
|
160
158
|
class RunTransferJobRequest
|
161
159
|
include ::Google::Protobuf::MessageExts
|
162
160
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
163
161
|
end
|
162
|
+
|
163
|
+
# Specifies the request passed to CreateAgentPool.
|
164
|
+
# @!attribute [rw] project_id
|
165
|
+
# @return [::String]
|
166
|
+
# Required. The ID of the Google Cloud project that owns the
|
167
|
+
# agent pool.
|
168
|
+
# @!attribute [rw] agent_pool
|
169
|
+
# @return [::Google::Cloud::StorageTransfer::V1::AgentPool]
|
170
|
+
# Required. The agent pool to create.
|
171
|
+
# @!attribute [rw] agent_pool_id
|
172
|
+
# @return [::String]
|
173
|
+
# Required. The ID of the agent pool to create.
|
174
|
+
#
|
175
|
+
# The `agent_pool_id` must meet the following requirements:
|
176
|
+
#
|
177
|
+
# * Length of 128 characters or less.
|
178
|
+
# * Not start with the string `goog`.
|
179
|
+
# * Start with a lowercase ASCII character, followed by:
|
180
|
+
# * Zero or more: lowercase Latin alphabet characters, numerals,
|
181
|
+
# hyphens (`-`), periods (`.`), underscores (`_`), or tildes (`~`).
|
182
|
+
# * One or more numerals or lowercase ASCII characters.
|
183
|
+
#
|
184
|
+
# As expressed by the regular expression:
|
185
|
+
# `^(?!goog)[a-z]([a-z0-9-._~]*[a-z0-9])?$`.
|
186
|
+
class CreateAgentPoolRequest
|
187
|
+
include ::Google::Protobuf::MessageExts
|
188
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
189
|
+
end
|
190
|
+
|
191
|
+
# Specifies the request passed to UpdateAgentPool.
|
192
|
+
# @!attribute [rw] agent_pool
|
193
|
+
# @return [::Google::Cloud::StorageTransfer::V1::AgentPool]
|
194
|
+
# Required. The agent pool to update. `agent_pool` is expected to specify following
|
195
|
+
# fields:
|
196
|
+
#
|
197
|
+
# * {::Google::Cloud::StorageTransfer::V1::AgentPool#name name}
|
198
|
+
#
|
199
|
+
# * {::Google::Cloud::StorageTransfer::V1::AgentPool#display_name display_name}
|
200
|
+
#
|
201
|
+
# * {::Google::Cloud::StorageTransfer::V1::AgentPool#bandwidth_limit bandwidth_limit}
|
202
|
+
# An `UpdateAgentPoolRequest` with any other fields is rejected
|
203
|
+
# with the error {::Google::Rpc::Code::INVALID_ARGUMENT INVALID_ARGUMENT}.
|
204
|
+
# @!attribute [rw] update_mask
|
205
|
+
# @return [::Google::Protobuf::FieldMask]
|
206
|
+
# The [field mask]
|
207
|
+
# (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf)
|
208
|
+
# of the fields in `agentPool` to update in this request.
|
209
|
+
# The following `agentPool` fields can be updated:
|
210
|
+
#
|
211
|
+
# * {::Google::Cloud::StorageTransfer::V1::AgentPool#display_name display_name}
|
212
|
+
#
|
213
|
+
# * {::Google::Cloud::StorageTransfer::V1::AgentPool#bandwidth_limit bandwidth_limit}
|
214
|
+
class UpdateAgentPoolRequest
|
215
|
+
include ::Google::Protobuf::MessageExts
|
216
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
217
|
+
end
|
218
|
+
|
219
|
+
# Specifies the request passed to GetAgentPool.
|
220
|
+
# @!attribute [rw] name
|
221
|
+
# @return [::String]
|
222
|
+
# Required. The name of the agent pool to get.
|
223
|
+
class GetAgentPoolRequest
|
224
|
+
include ::Google::Protobuf::MessageExts
|
225
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
226
|
+
end
|
227
|
+
|
228
|
+
# Specifies the request passed to DeleteAgentPool.
|
229
|
+
# @!attribute [rw] name
|
230
|
+
# @return [::String]
|
231
|
+
# Required. The name of the agent pool to delete.
|
232
|
+
class DeleteAgentPoolRequest
|
233
|
+
include ::Google::Protobuf::MessageExts
|
234
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
235
|
+
end
|
236
|
+
|
237
|
+
# The request passed to ListAgentPools.
|
238
|
+
# @!attribute [rw] project_id
|
239
|
+
# @return [::String]
|
240
|
+
# Required. The ID of the Google Cloud project that owns the job.
|
241
|
+
# @!attribute [rw] filter
|
242
|
+
# @return [::String]
|
243
|
+
# An optional list of query parameters specified as JSON text in the
|
244
|
+
# form of:
|
245
|
+
#
|
246
|
+
# `{"agentPoolNames":["agentpool1","agentpool2",...]}`
|
247
|
+
#
|
248
|
+
# Since `agentPoolNames` support multiple values, its values must be
|
249
|
+
# specified with array notation. When the filter is either empty or not
|
250
|
+
# provided, the list returns all agent pools for the project.
|
251
|
+
# @!attribute [rw] page_size
|
252
|
+
# @return [::Integer]
|
253
|
+
# The list page size. The max allowed value is `256`.
|
254
|
+
# @!attribute [rw] page_token
|
255
|
+
# @return [::String]
|
256
|
+
# The list page token.
|
257
|
+
class ListAgentPoolsRequest
|
258
|
+
include ::Google::Protobuf::MessageExts
|
259
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
260
|
+
end
|
261
|
+
|
262
|
+
# Response from ListAgentPools.
|
263
|
+
# @!attribute [rw] agent_pools
|
264
|
+
# @return [::Array<::Google::Cloud::StorageTransfer::V1::AgentPool>]
|
265
|
+
# A list of agent pools.
|
266
|
+
# @!attribute [rw] next_page_token
|
267
|
+
# @return [::String]
|
268
|
+
# The list next page token.
|
269
|
+
class ListAgentPoolsResponse
|
270
|
+
include ::Google::Protobuf::MessageExts
|
271
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
272
|
+
end
|
164
273
|
end
|
165
274
|
end
|
166
275
|
end
|