google-apis-storagetransfer_v1 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +13 -0
- data/CHANGELOG.md +7 -0
- data/LICENSE.md +202 -0
- data/OVERVIEW.md +96 -0
- data/lib/google-apis-storagetransfer_v1.rb +15 -0
- data/lib/google/apis/storagetransfer_v1.rb +37 -0
- data/lib/google/apis/storagetransfer_v1/classes.rb +1260 -0
- data/lib/google/apis/storagetransfer_v1/gem_version.rb +28 -0
- data/lib/google/apis/storagetransfer_v1/representations.rb +489 -0
- data/lib/google/apis/storagetransfer_v1/service.rb +432 -0
- metadata +76 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 33beef39971f8bfc7a6fdb9fc3fd16da7e5df20f3632dee4f6d48e0f0251e1f2
|
4
|
+
data.tar.gz: fd8b01675092c799fb65a831534c704cce9ab06b5beffa701a83cfd00251ab83
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 85aed3dcfe580764d6acff07cbe14528a98a8eacfee85f684a32199101d6f0a31ed8611bf4939506de9e0ec72207cd6abf235e96ad7dcf4d475942167764402b
|
7
|
+
data.tar.gz: 36ca333b5610ef6ae1c52ab1e96b891e448488a4fbed828e835f57b66952fc232b19402d33fe78e95165c3a552414771c9293ec59010c15b88fb054623b5b283
|
data/.yardopts
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
--hide-void-return
|
2
|
+
--no-private
|
3
|
+
--verbose
|
4
|
+
--title=google-apis-storagetransfer_v1
|
5
|
+
--markup-provider=redcarpet
|
6
|
+
--markup=markdown
|
7
|
+
--main OVERVIEW.md
|
8
|
+
lib/google/apis/storagetransfer_v1/*.rb
|
9
|
+
lib/google/apis/storagetransfer_v1.rb
|
10
|
+
-
|
11
|
+
OVERVIEW.md
|
12
|
+
CHANGELOG.md
|
13
|
+
LICENSE.md
|
data/CHANGELOG.md
ADDED
data/LICENSE.md
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/OVERVIEW.md
ADDED
@@ -0,0 +1,96 @@
|
|
1
|
+
# Simple REST client for version V1 of the Storage Transfer API
|
2
|
+
|
3
|
+
This is a simple client library for version V1 of the Storage Transfer API. It provides:
|
4
|
+
|
5
|
+
* A client object that connects to the HTTP/JSON REST endpoint for the service.
|
6
|
+
* Ruby objects for data structures related to the service.
|
7
|
+
* Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
|
8
|
+
* Control of retry, pagination, and timeouts.
|
9
|
+
|
10
|
+
Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
|
11
|
+
|
12
|
+
## Getting started
|
13
|
+
|
14
|
+
### Before you begin
|
15
|
+
|
16
|
+
There are a few setup steps you need to complete before you can use this library:
|
17
|
+
|
18
|
+
1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
|
19
|
+
2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
|
20
|
+
3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/storagetransfer.googleapis.com) in the console.
|
21
|
+
|
22
|
+
### Installation
|
23
|
+
|
24
|
+
Add this line to your application's Gemfile:
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
gem 'google-apis-storagetransfer_v1', '~> 0.1'
|
28
|
+
```
|
29
|
+
|
30
|
+
And then execute:
|
31
|
+
|
32
|
+
```
|
33
|
+
$ bundle
|
34
|
+
```
|
35
|
+
|
36
|
+
Or install it yourself as:
|
37
|
+
|
38
|
+
```
|
39
|
+
$ gem install google-apis-storagetransfer_v1
|
40
|
+
```
|
41
|
+
|
42
|
+
### Creating a client object
|
43
|
+
|
44
|
+
Once the gem is installed, you can load the client code and instantiate a client.
|
45
|
+
|
46
|
+
```ruby
|
47
|
+
# Load the client
|
48
|
+
require "google/apis/storagetransfer_v1"
|
49
|
+
|
50
|
+
# Create a client object
|
51
|
+
client = Google::Apis::StoragetransferV1::StoragetransferService.new
|
52
|
+
|
53
|
+
# Authenticate calls
|
54
|
+
client.authentication = # ... use the googleauth gem to create credentials
|
55
|
+
```
|
56
|
+
|
57
|
+
See the class reference docs for information on the methods you can call from a client.
|
58
|
+
|
59
|
+
## Documentation
|
60
|
+
|
61
|
+
More detailed descriptions of the Google simple REST clients are available in two documents.
|
62
|
+
|
63
|
+
* The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
|
64
|
+
* The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
|
65
|
+
|
66
|
+
(Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Storagetransfer service in particular.)
|
67
|
+
|
68
|
+
For reference information on specific calls in the Storage Transfer API, see the {Google::Apis::StoragetransferV1::StoragetransferService class reference docs}.
|
69
|
+
|
70
|
+
## Which client should I use?
|
71
|
+
|
72
|
+
Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
|
73
|
+
|
74
|
+
This library, `google-apis-storagetransfer_v1`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
|
75
|
+
|
76
|
+
Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
|
77
|
+
|
78
|
+
Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
|
79
|
+
|
80
|
+
**For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
|
81
|
+
|
82
|
+
The [product documentation](https://cloud.google.com/storage-transfer/docs) may provide guidance regarding the preferred client library to use.
|
83
|
+
|
84
|
+
## Supported Ruby versions
|
85
|
+
|
86
|
+
This library is supported on Ruby 2.5+.
|
87
|
+
|
88
|
+
Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
|
89
|
+
|
90
|
+
## License
|
91
|
+
|
92
|
+
This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
|
93
|
+
|
94
|
+
## Support
|
95
|
+
|
96
|
+
Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require "google/apis/storagetransfer_v1"
|
@@ -0,0 +1,37 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'google/apis/storagetransfer_v1/service.rb'
|
16
|
+
require 'google/apis/storagetransfer_v1/classes.rb'
|
17
|
+
require 'google/apis/storagetransfer_v1/representations.rb'
|
18
|
+
require 'google/apis/storagetransfer_v1/gem_version.rb'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
# Storage Transfer API
|
23
|
+
#
|
24
|
+
# Transfers data from external data sources to a Google Cloud Storage bucket or
|
25
|
+
# between Google Cloud Storage buckets.
|
26
|
+
#
|
27
|
+
# @see https://cloud.google.com/storage-transfer/docs
|
28
|
+
module StoragetransferV1
|
29
|
+
# Version of the Storage Transfer API this client connects to.
|
30
|
+
# This is NOT the gem version.
|
31
|
+
VERSION = 'V1'
|
32
|
+
|
33
|
+
# View and manage your data across Google Cloud Platform services
|
34
|
+
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -0,0 +1,1260 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'date'
|
16
|
+
require 'google/apis/core/base_service'
|
17
|
+
require 'google/apis/core/json_representation'
|
18
|
+
require 'google/apis/core/hashable'
|
19
|
+
require 'google/apis/errors'
|
20
|
+
|
21
|
+
module Google
|
22
|
+
module Apis
|
23
|
+
module StoragetransferV1
|
24
|
+
|
25
|
+
# AWS access key (see [AWS Security Credentials](https://docs.aws.amazon.com/
|
26
|
+
# general/latest/gr/aws-security-credentials.html)). For information on our data
|
27
|
+
# retention policy for user credentials, see [User credentials](data-retention#
|
28
|
+
# user-credentials).
|
29
|
+
class AwsAccessKey
|
30
|
+
include Google::Apis::Core::Hashable
|
31
|
+
|
32
|
+
# Required. AWS access key ID.
|
33
|
+
# Corresponds to the JSON property `accessKeyId`
|
34
|
+
# @return [String]
|
35
|
+
attr_accessor :access_key_id
|
36
|
+
|
37
|
+
# Required. AWS secret access key. This field is not returned in RPC responses.
|
38
|
+
# Corresponds to the JSON property `secretAccessKey`
|
39
|
+
# @return [String]
|
40
|
+
attr_accessor :secret_access_key
|
41
|
+
|
42
|
+
def initialize(**args)
|
43
|
+
update!(**args)
|
44
|
+
end
|
45
|
+
|
46
|
+
# Update properties of this object
|
47
|
+
def update!(**args)
|
48
|
+
@access_key_id = args[:access_key_id] if args.key?(:access_key_id)
|
49
|
+
@secret_access_key = args[:secret_access_key] if args.key?(:secret_access_key)
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
53
|
+
# An AwsS3Data resource can be a data source, but not a data sink. In an
|
54
|
+
# AwsS3Data resource, an object's name is the S3 object's key name.
|
55
|
+
class AwsS3Data
|
56
|
+
include Google::Apis::Core::Hashable
|
57
|
+
|
58
|
+
# AWS access key (see [AWS Security Credentials](https://docs.aws.amazon.com/
|
59
|
+
# general/latest/gr/aws-security-credentials.html)). For information on our data
|
60
|
+
# retention policy for user credentials, see [User credentials](data-retention#
|
61
|
+
# user-credentials).
|
62
|
+
# Corresponds to the JSON property `awsAccessKey`
|
63
|
+
# @return [Google::Apis::StoragetransferV1::AwsAccessKey]
|
64
|
+
attr_accessor :aws_access_key
|
65
|
+
|
66
|
+
# Required. S3 Bucket name (see [Creating a bucket](https://docs.aws.amazon.com/
|
67
|
+
# AmazonS3/latest/dev/create-bucket-get-location-example.html)).
|
68
|
+
# Corresponds to the JSON property `bucketName`
|
69
|
+
# @return [String]
|
70
|
+
attr_accessor :bucket_name
|
71
|
+
|
72
|
+
# Root path to transfer objects. Must be an empty string or full path name that
|
73
|
+
# ends with a '/'. This field is treated as an object prefix. As such, it should
|
74
|
+
# generally not begin with a '/'.
|
75
|
+
# Corresponds to the JSON property `path`
|
76
|
+
# @return [String]
|
77
|
+
attr_accessor :path
|
78
|
+
|
79
|
+
def initialize(**args)
|
80
|
+
update!(**args)
|
81
|
+
end
|
82
|
+
|
83
|
+
# Update properties of this object
|
84
|
+
def update!(**args)
|
85
|
+
@aws_access_key = args[:aws_access_key] if args.key?(:aws_access_key)
|
86
|
+
@bucket_name = args[:bucket_name] if args.key?(:bucket_name)
|
87
|
+
@path = args[:path] if args.key?(:path)
|
88
|
+
end
|
89
|
+
end
|
90
|
+
|
91
|
+
# An AzureBlobStorageData resource can be a data source, but not a data sink. An
|
92
|
+
# AzureBlobStorageData resource represents one Azure container. The storage
|
93
|
+
# account determines the [Azure endpoint](https://docs.microsoft.com/en-us/azure/
|
94
|
+
# storage/common/storage-create-storage-account#storage-account-endpoints). In
|
95
|
+
# an AzureBlobStorageData resource, a blobs's name is the [Azure Blob Storage
|
96
|
+
# blob's key name](https://docs.microsoft.com/en-us/rest/api/storageservices/
|
97
|
+
# naming-and-referencing-containers--blobs--and-metadata#blob-names).
|
98
|
+
class AzureBlobStorageData
|
99
|
+
include Google::Apis::Core::Hashable
|
100
|
+
|
101
|
+
# Azure credentials For information on our data retention policy for user
|
102
|
+
# credentials, see [User credentials](data-retention#user-credentials).
|
103
|
+
# Corresponds to the JSON property `azureCredentials`
|
104
|
+
# @return [Google::Apis::StoragetransferV1::AzureCredentials]
|
105
|
+
attr_accessor :azure_credentials
|
106
|
+
|
107
|
+
# Required. The container to transfer from the Azure Storage account.
|
108
|
+
# Corresponds to the JSON property `container`
|
109
|
+
# @return [String]
|
110
|
+
attr_accessor :container
|
111
|
+
|
112
|
+
# Root path to transfer objects. Must be an empty string or full path name that
|
113
|
+
# ends with a '/'. This field is treated as an object prefix. As such, it should
|
114
|
+
# generally not begin with a '/'.
|
115
|
+
# Corresponds to the JSON property `path`
|
116
|
+
# @return [String]
|
117
|
+
attr_accessor :path
|
118
|
+
|
119
|
+
# Required. The name of the Azure Storage account.
|
120
|
+
# Corresponds to the JSON property `storageAccount`
|
121
|
+
# @return [String]
|
122
|
+
attr_accessor :storage_account
|
123
|
+
|
124
|
+
def initialize(**args)
|
125
|
+
update!(**args)
|
126
|
+
end
|
127
|
+
|
128
|
+
# Update properties of this object
|
129
|
+
def update!(**args)
|
130
|
+
@azure_credentials = args[:azure_credentials] if args.key?(:azure_credentials)
|
131
|
+
@container = args[:container] if args.key?(:container)
|
132
|
+
@path = args[:path] if args.key?(:path)
|
133
|
+
@storage_account = args[:storage_account] if args.key?(:storage_account)
|
134
|
+
end
|
135
|
+
end
|
136
|
+
|
137
|
+
# Azure credentials For information on our data retention policy for user
|
138
|
+
# credentials, see [User credentials](data-retention#user-credentials).
|
139
|
+
class AzureCredentials
|
140
|
+
include Google::Apis::Core::Hashable
|
141
|
+
|
142
|
+
# Required. Azure shared access signature. (see [Grant limited access to Azure
|
143
|
+
# Storage resources using shared access signatures (SAS)](https://docs.microsoft.
|
144
|
+
# com/en-us/azure/storage/common/storage-sas-overview)).
|
145
|
+
# Corresponds to the JSON property `sasToken`
|
146
|
+
# @return [String]
|
147
|
+
attr_accessor :sas_token
|
148
|
+
|
149
|
+
def initialize(**args)
|
150
|
+
update!(**args)
|
151
|
+
end
|
152
|
+
|
153
|
+
# Update properties of this object
|
154
|
+
def update!(**args)
|
155
|
+
@sas_token = args[:sas_token] if args.key?(:sas_token)
|
156
|
+
end
|
157
|
+
end
|
158
|
+
|
159
|
+
# The request message for Operations.CancelOperation.
|
160
|
+
class CancelOperationRequest
|
161
|
+
include Google::Apis::Core::Hashable
|
162
|
+
|
163
|
+
def initialize(**args)
|
164
|
+
update!(**args)
|
165
|
+
end
|
166
|
+
|
167
|
+
# Update properties of this object
|
168
|
+
def update!(**args)
|
169
|
+
end
|
170
|
+
end
|
171
|
+
|
172
|
+
# Represents a whole or partial calendar date, such as a birthday. The time of
|
173
|
+
# day and time zone are either specified elsewhere or are insignificant. The
|
174
|
+
# date is relative to the Gregorian Calendar. This can represent one of the
|
175
|
+
# following: * A full date, with non-zero year, month, and day values * A month
|
176
|
+
# and day value, with a zero year, such as an anniversary * A year on its own,
|
177
|
+
# with zero month and day values * A year and month value, with a zero day, such
|
178
|
+
# as a credit card expiration date Related types are google.type.TimeOfDay and `
|
179
|
+
# google.protobuf.Timestamp`.
|
180
|
+
class Date
|
181
|
+
include Google::Apis::Core::Hashable
|
182
|
+
|
183
|
+
# Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
|
184
|
+
# specify a year by itself or a year and month where the day isn't significant.
|
185
|
+
# Corresponds to the JSON property `day`
|
186
|
+
# @return [Fixnum]
|
187
|
+
attr_accessor :day
|
188
|
+
|
189
|
+
# Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
|
190
|
+
# and day.
|
191
|
+
# Corresponds to the JSON property `month`
|
192
|
+
# @return [Fixnum]
|
193
|
+
attr_accessor :month
|
194
|
+
|
195
|
+
# Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
|
196
|
+
# year.
|
197
|
+
# Corresponds to the JSON property `year`
|
198
|
+
# @return [Fixnum]
|
199
|
+
attr_accessor :year
|
200
|
+
|
201
|
+
def initialize(**args)
|
202
|
+
update!(**args)
|
203
|
+
end
|
204
|
+
|
205
|
+
# Update properties of this object
|
206
|
+
def update!(**args)
|
207
|
+
@day = args[:day] if args.key?(:day)
|
208
|
+
@month = args[:month] if args.key?(:month)
|
209
|
+
@year = args[:year] if args.key?(:year)
|
210
|
+
end
|
211
|
+
end
|
212
|
+
|
213
|
+
# A generic empty message that you can re-use to avoid defining duplicated empty
|
214
|
+
# messages in your APIs. A typical example is to use it as the request or the
|
215
|
+
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
216
|
+
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
217
|
+
# `Empty` is empty JSON object ````.
|
218
|
+
class Empty
|
219
|
+
include Google::Apis::Core::Hashable
|
220
|
+
|
221
|
+
def initialize(**args)
|
222
|
+
update!(**args)
|
223
|
+
end
|
224
|
+
|
225
|
+
# Update properties of this object
|
226
|
+
def update!(**args)
|
227
|
+
end
|
228
|
+
end
|
229
|
+
|
230
|
+
# An entry describing an error that has occurred.
|
231
|
+
class ErrorLogEntry
|
232
|
+
include Google::Apis::Core::Hashable
|
233
|
+
|
234
|
+
# A list of messages that carry the error details.
|
235
|
+
# Corresponds to the JSON property `errorDetails`
|
236
|
+
# @return [Array<String>]
|
237
|
+
attr_accessor :error_details
|
238
|
+
|
239
|
+
# Required. A URL that refers to the target (a data source, a data sink, or an
|
240
|
+
# object) with which the error is associated.
|
241
|
+
# Corresponds to the JSON property `url`
|
242
|
+
# @return [String]
|
243
|
+
attr_accessor :url
|
244
|
+
|
245
|
+
def initialize(**args)
|
246
|
+
update!(**args)
|
247
|
+
end
|
248
|
+
|
249
|
+
# Update properties of this object
|
250
|
+
def update!(**args)
|
251
|
+
@error_details = args[:error_details] if args.key?(:error_details)
|
252
|
+
@url = args[:url] if args.key?(:url)
|
253
|
+
end
|
254
|
+
end
|
255
|
+
|
256
|
+
# A summary of errors by error code, plus a count and sample error log entries.
|
257
|
+
class ErrorSummary
|
258
|
+
include Google::Apis::Core::Hashable
|
259
|
+
|
260
|
+
# Required.
|
261
|
+
# Corresponds to the JSON property `errorCode`
|
262
|
+
# @return [String]
|
263
|
+
attr_accessor :error_code
|
264
|
+
|
265
|
+
# Required. Count of this type of error.
|
266
|
+
# Corresponds to the JSON property `errorCount`
|
267
|
+
# @return [Fixnum]
|
268
|
+
attr_accessor :error_count
|
269
|
+
|
270
|
+
# Error samples. At most 5 error log entries will be recorded for a given error
|
271
|
+
# code for a single transfer operation.
|
272
|
+
# Corresponds to the JSON property `errorLogEntries`
|
273
|
+
# @return [Array<Google::Apis::StoragetransferV1::ErrorLogEntry>]
|
274
|
+
attr_accessor :error_log_entries
|
275
|
+
|
276
|
+
def initialize(**args)
|
277
|
+
update!(**args)
|
278
|
+
end
|
279
|
+
|
280
|
+
# Update properties of this object
|
281
|
+
def update!(**args)
|
282
|
+
@error_code = args[:error_code] if args.key?(:error_code)
|
283
|
+
@error_count = args[:error_count] if args.key?(:error_count)
|
284
|
+
@error_log_entries = args[:error_log_entries] if args.key?(:error_log_entries)
|
285
|
+
end
|
286
|
+
end
|
287
|
+
|
288
|
+
# In a GcsData resource, an object's name is the Cloud Storage object's name and
|
289
|
+
# its "last modification time" refers to the object's `updated` property of
|
290
|
+
# Cloud Storage objects, which changes when the content or the metadata of the
|
291
|
+
# object is updated.
|
292
|
+
class GcsData
|
293
|
+
include Google::Apis::Core::Hashable
|
294
|
+
|
295
|
+
# Required. Cloud Storage bucket name (see [Bucket Name Requirements](https://
|
296
|
+
# cloud.google.com/storage/docs/naming#requirements)).
|
297
|
+
# Corresponds to the JSON property `bucketName`
|
298
|
+
# @return [String]
|
299
|
+
attr_accessor :bucket_name
|
300
|
+
|
301
|
+
# Root path to transfer objects. Must be an empty string or full path name that
|
302
|
+
# ends with a '/'. This field is treated as an object prefix. As such, it should
|
303
|
+
# generally not begin with a '/'. (must meet Object Name Requirements](https://
|
304
|
+
# cloud.google.com/storage/docs/naming#objectnames)).
|
305
|
+
# Corresponds to the JSON property `path`
|
306
|
+
# @return [String]
|
307
|
+
attr_accessor :path
|
308
|
+
|
309
|
+
def initialize(**args)
|
310
|
+
update!(**args)
|
311
|
+
end
|
312
|
+
|
313
|
+
# Update properties of this object
|
314
|
+
def update!(**args)
|
315
|
+
@bucket_name = args[:bucket_name] if args.key?(:bucket_name)
|
316
|
+
@path = args[:path] if args.key?(:path)
|
317
|
+
end
|
318
|
+
end
|
319
|
+
|
320
|
+
# Google service account
|
321
|
+
class GoogleServiceAccount
|
322
|
+
include Google::Apis::Core::Hashable
|
323
|
+
|
324
|
+
# Email address of the service account.
|
325
|
+
# Corresponds to the JSON property `accountEmail`
|
326
|
+
# @return [String]
|
327
|
+
attr_accessor :account_email
|
328
|
+
|
329
|
+
def initialize(**args)
|
330
|
+
update!(**args)
|
331
|
+
end
|
332
|
+
|
333
|
+
# Update properties of this object
|
334
|
+
def update!(**args)
|
335
|
+
@account_email = args[:account_email] if args.key?(:account_email)
|
336
|
+
end
|
337
|
+
end
|
338
|
+
|
339
|
+
# An HttpData resource specifies a list of objects on the web to be transferred
|
340
|
+
# over HTTP. The information of the objects to be transferred is contained in a
|
341
|
+
# file referenced by a URL. The first line in the file must be `"TsvHttpData-1.0"
|
342
|
+
# `, which specifies the format of the file. Subsequent lines specify the
|
343
|
+
# information of the list of objects, one object per list entry. Each entry has
|
344
|
+
# the following tab-delimited fields: * **HTTP URL** — The location of the
|
345
|
+
# object. * **Length** — The size of the object in bytes. * **MD5** — The base64-
|
346
|
+
# encoded MD5 hash of the object. For an example of a valid TSV file, see [
|
347
|
+
# Transferring data from URLs](https://cloud.google.com/storage-transfer/docs/
|
348
|
+
# create-url-list). When transferring data based on a URL list, keep the
|
349
|
+
# following in mind: * When an object located at `http(s)://hostname:port/` is
|
350
|
+
# transferred to a data sink, the name of the object at the data sink is `/`. *
|
351
|
+
# If the specified size of an object does not match the actual size of the
|
352
|
+
# object fetched, the object will not be transferred. * If the specified MD5
|
353
|
+
# does not match the MD5 computed from the transferred bytes, the object
|
354
|
+
# transfer will fail. * Ensure that each URL you specify is publicly accessible.
|
355
|
+
# For example, in Cloud Storage you can [share an object publicly] (https://
|
356
|
+
# cloud.google.com/storage/docs/cloud-console#_sharingdata) and get a link to it.
|
357
|
+
# * Storage Transfer Service obeys `robots.txt` rules and requires the source
|
358
|
+
# HTTP server to support `Range` requests and to return a `Content-Length`
|
359
|
+
# header in each response. * ObjectConditions have no effect when filtering
|
360
|
+
# objects to transfer.
|
361
|
+
class HttpData
|
362
|
+
include Google::Apis::Core::Hashable
|
363
|
+
|
364
|
+
# Required. The URL that points to the file that stores the object list entries.
|
365
|
+
# This file must allow public access. Currently, only URLs with HTTP and HTTPS
|
366
|
+
# schemes are supported.
|
367
|
+
# Corresponds to the JSON property `listUrl`
|
368
|
+
# @return [String]
|
369
|
+
attr_accessor :list_url
|
370
|
+
|
371
|
+
def initialize(**args)
|
372
|
+
update!(**args)
|
373
|
+
end
|
374
|
+
|
375
|
+
# Update properties of this object
|
376
|
+
def update!(**args)
|
377
|
+
@list_url = args[:list_url] if args.key?(:list_url)
|
378
|
+
end
|
379
|
+
end
|
380
|
+
|
381
|
+
# The response message for Operations.ListOperations.
|
382
|
+
class ListOperationsResponse
|
383
|
+
include Google::Apis::Core::Hashable
|
384
|
+
|
385
|
+
# The standard List next-page token.
|
386
|
+
# Corresponds to the JSON property `nextPageToken`
|
387
|
+
# @return [String]
|
388
|
+
attr_accessor :next_page_token
|
389
|
+
|
390
|
+
# A list of operations that matches the specified filter in the request.
|
391
|
+
# Corresponds to the JSON property `operations`
|
392
|
+
# @return [Array<Google::Apis::StoragetransferV1::Operation>]
|
393
|
+
attr_accessor :operations
|
394
|
+
|
395
|
+
def initialize(**args)
|
396
|
+
update!(**args)
|
397
|
+
end
|
398
|
+
|
399
|
+
# Update properties of this object
|
400
|
+
def update!(**args)
|
401
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
402
|
+
@operations = args[:operations] if args.key?(:operations)
|
403
|
+
end
|
404
|
+
end
|
405
|
+
|
406
|
+
# Response from ListTransferJobs.
|
407
|
+
class ListTransferJobsResponse
|
408
|
+
include Google::Apis::Core::Hashable
|
409
|
+
|
410
|
+
# The list next page token.
|
411
|
+
# Corresponds to the JSON property `nextPageToken`
|
412
|
+
# @return [String]
|
413
|
+
attr_accessor :next_page_token
|
414
|
+
|
415
|
+
# A list of transfer jobs.
|
416
|
+
# Corresponds to the JSON property `transferJobs`
|
417
|
+
# @return [Array<Google::Apis::StoragetransferV1::TransferJob>]
|
418
|
+
attr_accessor :transfer_jobs
|
419
|
+
|
420
|
+
def initialize(**args)
|
421
|
+
update!(**args)
|
422
|
+
end
|
423
|
+
|
424
|
+
# Update properties of this object
|
425
|
+
def update!(**args)
|
426
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
427
|
+
@transfer_jobs = args[:transfer_jobs] if args.key?(:transfer_jobs)
|
428
|
+
end
|
429
|
+
end
|
430
|
+
|
431
|
+
# Specification to configure notifications published to Cloud Pub/Sub.
|
432
|
+
# Notifications will be published to the customer-provided topic using the
|
433
|
+
# following `PubsubMessage.attributes`: * `"eventType"`: one of the EventType
|
434
|
+
# values * `"payloadFormat"`: one of the PayloadFormat values * `"projectId"`:
|
435
|
+
# the project_id of the `TransferOperation` * `"transferJobName"`: the
|
436
|
+
# transfer_job_name of the `TransferOperation` * `"transferOperationName"`: the
|
437
|
+
# name of the `TransferOperation` The `PubsubMessage.data` will contain a
|
438
|
+
# TransferOperation resource formatted according to the specified `PayloadFormat`
|
439
|
+
# .
|
440
|
+
class NotificationConfig
|
441
|
+
include Google::Apis::Core::Hashable
|
442
|
+
|
443
|
+
# Event types for which a notification is desired. If empty, send notifications
|
444
|
+
# for all event types.
|
445
|
+
# Corresponds to the JSON property `eventTypes`
|
446
|
+
# @return [Array<String>]
|
447
|
+
attr_accessor :event_types
|
448
|
+
|
449
|
+
# Required. The desired format of the notification message payloads.
|
450
|
+
# Corresponds to the JSON property `payloadFormat`
|
451
|
+
# @return [String]
|
452
|
+
attr_accessor :payload_format
|
453
|
+
|
454
|
+
# Required. The `Topic.name` of the Cloud Pub/Sub topic to which to publish
|
455
|
+
# notifications. Must be of the format: `projects/`project`/topics/`topic``. Not
|
456
|
+
# matching this format will result in an INVALID_ARGUMENT error.
|
457
|
+
# Corresponds to the JSON property `pubsubTopic`
|
458
|
+
# @return [String]
|
459
|
+
attr_accessor :pubsub_topic
|
460
|
+
|
461
|
+
def initialize(**args)
|
462
|
+
update!(**args)
|
463
|
+
end
|
464
|
+
|
465
|
+
# Update properties of this object
|
466
|
+
def update!(**args)
|
467
|
+
@event_types = args[:event_types] if args.key?(:event_types)
|
468
|
+
@payload_format = args[:payload_format] if args.key?(:payload_format)
|
469
|
+
@pubsub_topic = args[:pubsub_topic] if args.key?(:pubsub_topic)
|
470
|
+
end
|
471
|
+
end
|
472
|
+
|
473
|
+
# Conditions that determine which objects will be transferred. Applies only to
|
474
|
+
# Cloud Data Sources such as S3, Azure, and Cloud Storage. The "last
|
475
|
+
# modification time" refers to the time of the last change to the object's
|
476
|
+
# content or metadata — specifically, this is the `updated` property of Cloud
|
477
|
+
# Storage objects, the `LastModified` field of S3 objects, and the `Last-
|
478
|
+
# Modified` header of Azure blobs.
|
479
|
+
class ObjectConditions
|
480
|
+
include Google::Apis::Core::Hashable
|
481
|
+
|
482
|
+
# `exclude_prefixes` must follow the requirements described for include_prefixes.
|
483
|
+
# The max size of `exclude_prefixes` is 1000.
|
484
|
+
# Corresponds to the JSON property `excludePrefixes`
|
485
|
+
# @return [Array<String>]
|
486
|
+
attr_accessor :exclude_prefixes
|
487
|
+
|
488
|
+
# If `include_prefixes` is specified, objects that satisfy the object conditions
|
489
|
+
# must have names that start with one of the `include_prefixes` and that do not
|
490
|
+
# start with any of the exclude_prefixes. If `include_prefixes` is not specified,
|
491
|
+
# all objects except those that have names starting with one of the `
|
492
|
+
# exclude_prefixes` must satisfy the object conditions. Requirements: * Each
|
493
|
+
# include-prefix and exclude-prefix can contain any sequence of Unicode
|
494
|
+
# characters, to a max length of 1024 bytes when UTF8-encoded, and must not
|
495
|
+
# contain Carriage Return or Line Feed characters. Wildcard matching and regular
|
496
|
+
# expression matching are not supported. * Each include-prefix and exclude-
|
497
|
+
# prefix must omit the leading slash. For example, to include the `requests.gz`
|
498
|
+
# object in a transfer from `s3://my-aws-bucket/logs/y=2015/requests.gz`,
|
499
|
+
# specify the include prefix as `logs/y=2015/requests.gz`. * None of the include-
|
500
|
+
# prefix or the exclude-prefix values can be empty, if specified. * Each include-
|
501
|
+
# prefix must include a distinct portion of the object namespace. No include-
|
502
|
+
# prefix may be a prefix of another include-prefix. * Each exclude-prefix must
|
503
|
+
# exclude a distinct portion of the object namespace. No exclude-prefix may be a
|
504
|
+
# prefix of another exclude-prefix. * If `include_prefixes` is specified, then
|
505
|
+
# each exclude-prefix must start with the value of a path explicitly included by
|
506
|
+
# `include_prefixes`. The max size of `include_prefixes` is 1000.
|
507
|
+
# Corresponds to the JSON property `includePrefixes`
|
508
|
+
# @return [Array<String>]
|
509
|
+
attr_accessor :include_prefixes
|
510
|
+
|
511
|
+
# If specified, only objects with a "last modification time" before this
|
512
|
+
# timestamp and objects that don't have a "last modification time" will be
|
513
|
+
# transferred.
|
514
|
+
# Corresponds to the JSON property `lastModifiedBefore`
|
515
|
+
# @return [String]
|
516
|
+
attr_accessor :last_modified_before
|
517
|
+
|
518
|
+
# If specified, only objects with a "last modification time" on or after this
|
519
|
+
# timestamp and objects that don't have a "last modification time" are
|
520
|
+
# transferred. The `last_modified_since` and `last_modified_before` fields can
|
521
|
+
# be used together for chunked data processing. For example, consider a script
|
522
|
+
# that processes each day's worth of data at a time. For that you'd set each of
|
523
|
+
# the fields as follows: * `last_modified_since` to the start of the day * `
|
524
|
+
# last_modified_before` to the end of the day
|
525
|
+
# Corresponds to the JSON property `lastModifiedSince`
|
526
|
+
# @return [String]
|
527
|
+
attr_accessor :last_modified_since
|
528
|
+
|
529
|
+
# If specified, only objects with a "last modification time" on or after `NOW` -
|
530
|
+
# `max_time_elapsed_since_last_modification` and objects that don't have a "last
|
531
|
+
# modification time" are transferred. For each TransferOperation started by this
|
532
|
+
# TransferJob, `NOW` refers to the start_time of the `TransferOperation`.
|
533
|
+
# Corresponds to the JSON property `maxTimeElapsedSinceLastModification`
|
534
|
+
# @return [String]
|
535
|
+
attr_accessor :max_time_elapsed_since_last_modification
|
536
|
+
|
537
|
+
# If specified, only objects with a "last modification time" before `NOW` - `
|
538
|
+
# min_time_elapsed_since_last_modification` and objects that don't have a "last
|
539
|
+
# modification time" are transferred. For each TransferOperation started by this
|
540
|
+
# TransferJob, `NOW` refers to the start_time of the `TransferOperation`.
|
541
|
+
# Corresponds to the JSON property `minTimeElapsedSinceLastModification`
|
542
|
+
# @return [String]
|
543
|
+
attr_accessor :min_time_elapsed_since_last_modification
|
544
|
+
|
545
|
+
def initialize(**args)
|
546
|
+
update!(**args)
|
547
|
+
end
|
548
|
+
|
549
|
+
# Update properties of this object
|
550
|
+
def update!(**args)
|
551
|
+
@exclude_prefixes = args[:exclude_prefixes] if args.key?(:exclude_prefixes)
|
552
|
+
@include_prefixes = args[:include_prefixes] if args.key?(:include_prefixes)
|
553
|
+
@last_modified_before = args[:last_modified_before] if args.key?(:last_modified_before)
|
554
|
+
@last_modified_since = args[:last_modified_since] if args.key?(:last_modified_since)
|
555
|
+
@max_time_elapsed_since_last_modification = args[:max_time_elapsed_since_last_modification] if args.key?(:max_time_elapsed_since_last_modification)
|
556
|
+
@min_time_elapsed_since_last_modification = args[:min_time_elapsed_since_last_modification] if args.key?(:min_time_elapsed_since_last_modification)
|
557
|
+
end
|
558
|
+
end
|
559
|
+
|
560
|
+
# This resource represents a long-running operation that is the result of a
|
561
|
+
# network API call.
|
562
|
+
class Operation
|
563
|
+
include Google::Apis::Core::Hashable
|
564
|
+
|
565
|
+
# If the value is `false`, it means the operation is still in progress. If `true`
|
566
|
+
# , the operation is completed, and either `error` or `response` is available.
|
567
|
+
# Corresponds to the JSON property `done`
|
568
|
+
# @return [Boolean]
|
569
|
+
attr_accessor :done
|
570
|
+
alias_method :done?, :done
|
571
|
+
|
572
|
+
# The `Status` type defines a logical error model that is suitable for different
|
573
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
574
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
575
|
+
# data: error code, error message, and error details. You can find out more
|
576
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
577
|
+
# //cloud.google.com/apis/design/errors).
|
578
|
+
# Corresponds to the JSON property `error`
|
579
|
+
# @return [Google::Apis::StoragetransferV1::Status]
|
580
|
+
attr_accessor :error
|
581
|
+
|
582
|
+
# Represents the transfer operation object. To request a TransferOperation
|
583
|
+
# object, use transferOperations.get.
|
584
|
+
# Corresponds to the JSON property `metadata`
|
585
|
+
# @return [Hash<String,Object>]
|
586
|
+
attr_accessor :metadata
|
587
|
+
|
588
|
+
# The server-assigned name, which is only unique within the same service that
|
589
|
+
# originally returns it. If you use the default HTTP mapping, the `name` should
|
590
|
+
# have the format of `transferOperations/some/unique/name`.
|
591
|
+
# Corresponds to the JSON property `name`
|
592
|
+
# @return [String]
|
593
|
+
attr_accessor :name
|
594
|
+
|
595
|
+
# The normal response of the operation in case of success. If the original
|
596
|
+
# method returns no data on success, such as `Delete`, the response is `google.
|
597
|
+
# protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
|
598
|
+
# the response should be the resource. For other methods, the response should
|
599
|
+
# have the type `XxxResponse`, where `Xxx` is the original method name. For
|
600
|
+
# example, if the original method name is `TakeSnapshot()`, the inferred
|
601
|
+
# response type is `TakeSnapshotResponse`.
|
602
|
+
# Corresponds to the JSON property `response`
|
603
|
+
# @return [Hash<String,Object>]
|
604
|
+
attr_accessor :response
|
605
|
+
|
606
|
+
def initialize(**args)
|
607
|
+
update!(**args)
|
608
|
+
end
|
609
|
+
|
610
|
+
# Update properties of this object
|
611
|
+
def update!(**args)
|
612
|
+
@done = args[:done] if args.key?(:done)
|
613
|
+
@error = args[:error] if args.key?(:error)
|
614
|
+
@metadata = args[:metadata] if args.key?(:metadata)
|
615
|
+
@name = args[:name] if args.key?(:name)
|
616
|
+
@response = args[:response] if args.key?(:response)
|
617
|
+
end
|
618
|
+
end
|
619
|
+
|
620
|
+
# Request passed to PauseTransferOperation.
|
621
|
+
class PauseTransferOperationRequest
|
622
|
+
include Google::Apis::Core::Hashable
|
623
|
+
|
624
|
+
def initialize(**args)
|
625
|
+
update!(**args)
|
626
|
+
end
|
627
|
+
|
628
|
+
# Update properties of this object
|
629
|
+
def update!(**args)
|
630
|
+
end
|
631
|
+
end
|
632
|
+
|
633
|
+
# Request passed to ResumeTransferOperation.
|
634
|
+
class ResumeTransferOperationRequest
|
635
|
+
include Google::Apis::Core::Hashable
|
636
|
+
|
637
|
+
def initialize(**args)
|
638
|
+
update!(**args)
|
639
|
+
end
|
640
|
+
|
641
|
+
# Update properties of this object
|
642
|
+
def update!(**args)
|
643
|
+
end
|
644
|
+
end
|
645
|
+
|
646
|
+
# Transfers can be scheduled to recur or to run just once.
|
647
|
+
class Schedule
|
648
|
+
include Google::Apis::Core::Hashable
|
649
|
+
|
650
|
+
# Represents a time of day. The date and time zone are either not significant or
|
651
|
+
# are specified elsewhere. An API may choose to allow leap seconds. Related
|
652
|
+
# types are google.type.Date and `google.protobuf.Timestamp`.
|
653
|
+
# Corresponds to the JSON property `endTimeOfDay`
|
654
|
+
# @return [Google::Apis::StoragetransferV1::TimeOfDay]
|
655
|
+
attr_accessor :end_time_of_day
|
656
|
+
|
657
|
+
# Interval between the start of each scheduled TransferOperation. If unspecified,
|
658
|
+
# the default value is 24 hours. This value may not be less than 1 hour.
|
659
|
+
# Corresponds to the JSON property `repeatInterval`
|
660
|
+
# @return [String]
|
661
|
+
attr_accessor :repeat_interval
|
662
|
+
|
663
|
+
# Represents a whole or partial calendar date, such as a birthday. The time of
|
664
|
+
# day and time zone are either specified elsewhere or are insignificant. The
|
665
|
+
# date is relative to the Gregorian Calendar. This can represent one of the
|
666
|
+
# following: * A full date, with non-zero year, month, and day values * A month
|
667
|
+
# and day value, with a zero year, such as an anniversary * A year on its own,
|
668
|
+
# with zero month and day values * A year and month value, with a zero day, such
|
669
|
+
# as a credit card expiration date Related types are google.type.TimeOfDay and `
|
670
|
+
# google.protobuf.Timestamp`.
|
671
|
+
# Corresponds to the JSON property `scheduleEndDate`
|
672
|
+
# @return [Google::Apis::StoragetransferV1::Date]
|
673
|
+
attr_accessor :schedule_end_date
|
674
|
+
|
675
|
+
# Represents a whole or partial calendar date, such as a birthday. The time of
|
676
|
+
# day and time zone are either specified elsewhere or are insignificant. The
|
677
|
+
# date is relative to the Gregorian Calendar. This can represent one of the
|
678
|
+
# following: * A full date, with non-zero year, month, and day values * A month
|
679
|
+
# and day value, with a zero year, such as an anniversary * A year on its own,
|
680
|
+
# with zero month and day values * A year and month value, with a zero day, such
|
681
|
+
# as a credit card expiration date Related types are google.type.TimeOfDay and `
|
682
|
+
# google.protobuf.Timestamp`.
|
683
|
+
# Corresponds to the JSON property `scheduleStartDate`
|
684
|
+
# @return [Google::Apis::StoragetransferV1::Date]
|
685
|
+
attr_accessor :schedule_start_date
|
686
|
+
|
687
|
+
# Represents a time of day. The date and time zone are either not significant or
|
688
|
+
# are specified elsewhere. An API may choose to allow leap seconds. Related
|
689
|
+
# types are google.type.Date and `google.protobuf.Timestamp`.
|
690
|
+
# Corresponds to the JSON property `startTimeOfDay`
|
691
|
+
# @return [Google::Apis::StoragetransferV1::TimeOfDay]
|
692
|
+
attr_accessor :start_time_of_day
|
693
|
+
|
694
|
+
def initialize(**args)
|
695
|
+
update!(**args)
|
696
|
+
end
|
697
|
+
|
698
|
+
# Update properties of this object
|
699
|
+
def update!(**args)
|
700
|
+
@end_time_of_day = args[:end_time_of_day] if args.key?(:end_time_of_day)
|
701
|
+
@repeat_interval = args[:repeat_interval] if args.key?(:repeat_interval)
|
702
|
+
@schedule_end_date = args[:schedule_end_date] if args.key?(:schedule_end_date)
|
703
|
+
@schedule_start_date = args[:schedule_start_date] if args.key?(:schedule_start_date)
|
704
|
+
@start_time_of_day = args[:start_time_of_day] if args.key?(:start_time_of_day)
|
705
|
+
end
|
706
|
+
end
|
707
|
+
|
708
|
+
# The `Status` type defines a logical error model that is suitable for different
|
709
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
710
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
711
|
+
# data: error code, error message, and error details. You can find out more
|
712
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
713
|
+
# //cloud.google.com/apis/design/errors).
|
714
|
+
class Status
|
715
|
+
include Google::Apis::Core::Hashable
|
716
|
+
|
717
|
+
# The status code, which should be an enum value of google.rpc.Code.
|
718
|
+
# Corresponds to the JSON property `code`
|
719
|
+
# @return [Fixnum]
|
720
|
+
attr_accessor :code
|
721
|
+
|
722
|
+
# A list of messages that carry the error details. There is a common set of
|
723
|
+
# message types for APIs to use.
|
724
|
+
# Corresponds to the JSON property `details`
|
725
|
+
# @return [Array<Hash<String,Object>>]
|
726
|
+
attr_accessor :details
|
727
|
+
|
728
|
+
# A developer-facing error message, which should be in English. Any user-facing
|
729
|
+
# error message should be localized and sent in the google.rpc.Status.details
|
730
|
+
# field, or localized by the client.
|
731
|
+
# Corresponds to the JSON property `message`
|
732
|
+
# @return [String]
|
733
|
+
attr_accessor :message
|
734
|
+
|
735
|
+
def initialize(**args)
|
736
|
+
update!(**args)
|
737
|
+
end
|
738
|
+
|
739
|
+
# Update properties of this object
|
740
|
+
def update!(**args)
|
741
|
+
@code = args[:code] if args.key?(:code)
|
742
|
+
@details = args[:details] if args.key?(:details)
|
743
|
+
@message = args[:message] if args.key?(:message)
|
744
|
+
end
|
745
|
+
end
|
746
|
+
|
747
|
+
# Represents a time of day. The date and time zone are either not significant or
|
748
|
+
# are specified elsewhere. An API may choose to allow leap seconds. Related
|
749
|
+
# types are google.type.Date and `google.protobuf.Timestamp`.
|
750
|
+
class TimeOfDay
|
751
|
+
include Google::Apis::Core::Hashable
|
752
|
+
|
753
|
+
# Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to
|
754
|
+
# allow the value "24:00:00" for scenarios like business closing time.
|
755
|
+
# Corresponds to the JSON property `hours`
|
756
|
+
# @return [Fixnum]
|
757
|
+
attr_accessor :hours
|
758
|
+
|
759
|
+
# Minutes of hour of day. Must be from 0 to 59.
|
760
|
+
# Corresponds to the JSON property `minutes`
|
761
|
+
# @return [Fixnum]
|
762
|
+
attr_accessor :minutes
|
763
|
+
|
764
|
+
# Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
|
765
|
+
# Corresponds to the JSON property `nanos`
|
766
|
+
# @return [Fixnum]
|
767
|
+
attr_accessor :nanos
|
768
|
+
|
769
|
+
# Seconds of minutes of the time. Must normally be from 0 to 59. An API may
|
770
|
+
# allow the value 60 if it allows leap-seconds.
|
771
|
+
# Corresponds to the JSON property `seconds`
|
772
|
+
# @return [Fixnum]
|
773
|
+
attr_accessor :seconds
|
774
|
+
|
775
|
+
def initialize(**args)
|
776
|
+
update!(**args)
|
777
|
+
end
|
778
|
+
|
779
|
+
# Update properties of this object
|
780
|
+
def update!(**args)
|
781
|
+
@hours = args[:hours] if args.key?(:hours)
|
782
|
+
@minutes = args[:minutes] if args.key?(:minutes)
|
783
|
+
@nanos = args[:nanos] if args.key?(:nanos)
|
784
|
+
@seconds = args[:seconds] if args.key?(:seconds)
|
785
|
+
end
|
786
|
+
end
|
787
|
+
|
788
|
+
# A collection of counters that report the progress of a transfer operation.
|
789
|
+
class TransferCounters
|
790
|
+
include Google::Apis::Core::Hashable
|
791
|
+
|
792
|
+
# Bytes that are copied to the data sink.
|
793
|
+
# Corresponds to the JSON property `bytesCopiedToSink`
|
794
|
+
# @return [Fixnum]
|
795
|
+
attr_accessor :bytes_copied_to_sink
|
796
|
+
|
797
|
+
# Bytes that are deleted from the data sink.
|
798
|
+
# Corresponds to the JSON property `bytesDeletedFromSink`
|
799
|
+
# @return [Fixnum]
|
800
|
+
attr_accessor :bytes_deleted_from_sink
|
801
|
+
|
802
|
+
# Bytes that are deleted from the data source.
|
803
|
+
# Corresponds to the JSON property `bytesDeletedFromSource`
|
804
|
+
# @return [Fixnum]
|
805
|
+
attr_accessor :bytes_deleted_from_source
|
806
|
+
|
807
|
+
# Bytes that failed to be deleted from the data sink.
|
808
|
+
# Corresponds to the JSON property `bytesFailedToDeleteFromSink`
|
809
|
+
# @return [Fixnum]
|
810
|
+
attr_accessor :bytes_failed_to_delete_from_sink
|
811
|
+
|
812
|
+
# Bytes found in the data source that are scheduled to be transferred, excluding
|
813
|
+
# any that are filtered based on object conditions or skipped due to sync.
|
814
|
+
# Corresponds to the JSON property `bytesFoundFromSource`
|
815
|
+
# @return [Fixnum]
|
816
|
+
attr_accessor :bytes_found_from_source
|
817
|
+
|
818
|
+
# Bytes found only in the data sink that are scheduled to be deleted.
|
819
|
+
# Corresponds to the JSON property `bytesFoundOnlyFromSink`
|
820
|
+
# @return [Fixnum]
|
821
|
+
attr_accessor :bytes_found_only_from_sink
|
822
|
+
|
823
|
+
# Bytes in the data source that failed to be transferred or that failed to be
|
824
|
+
# deleted after being transferred.
|
825
|
+
# Corresponds to the JSON property `bytesFromSourceFailed`
|
826
|
+
# @return [Fixnum]
|
827
|
+
attr_accessor :bytes_from_source_failed
|
828
|
+
|
829
|
+
# Bytes in the data source that are not transferred because they already exist
|
830
|
+
# in the data sink.
|
831
|
+
# Corresponds to the JSON property `bytesFromSourceSkippedBySync`
|
832
|
+
# @return [Fixnum]
|
833
|
+
attr_accessor :bytes_from_source_skipped_by_sync
|
834
|
+
|
835
|
+
# Objects that are copied to the data sink.
|
836
|
+
# Corresponds to the JSON property `objectsCopiedToSink`
|
837
|
+
# @return [Fixnum]
|
838
|
+
attr_accessor :objects_copied_to_sink
|
839
|
+
|
840
|
+
# Objects that are deleted from the data sink.
|
841
|
+
# Corresponds to the JSON property `objectsDeletedFromSink`
|
842
|
+
# @return [Fixnum]
|
843
|
+
attr_accessor :objects_deleted_from_sink
|
844
|
+
|
845
|
+
# Objects that are deleted from the data source.
|
846
|
+
# Corresponds to the JSON property `objectsDeletedFromSource`
|
847
|
+
# @return [Fixnum]
|
848
|
+
attr_accessor :objects_deleted_from_source
|
849
|
+
|
850
|
+
# Objects that failed to be deleted from the data sink.
|
851
|
+
# Corresponds to the JSON property `objectsFailedToDeleteFromSink`
|
852
|
+
# @return [Fixnum]
|
853
|
+
attr_accessor :objects_failed_to_delete_from_sink
|
854
|
+
|
855
|
+
# Objects found in the data source that are scheduled to be transferred,
|
856
|
+
# excluding any that are filtered based on object conditions or skipped due to
|
857
|
+
# sync.
|
858
|
+
# Corresponds to the JSON property `objectsFoundFromSource`
|
859
|
+
# @return [Fixnum]
|
860
|
+
attr_accessor :objects_found_from_source
|
861
|
+
|
862
|
+
# Objects found only in the data sink that are scheduled to be deleted.
|
863
|
+
# Corresponds to the JSON property `objectsFoundOnlyFromSink`
|
864
|
+
# @return [Fixnum]
|
865
|
+
attr_accessor :objects_found_only_from_sink
|
866
|
+
|
867
|
+
# Objects in the data source that failed to be transferred or that failed to be
|
868
|
+
# deleted after being transferred.
|
869
|
+
# Corresponds to the JSON property `objectsFromSourceFailed`
|
870
|
+
# @return [Fixnum]
|
871
|
+
attr_accessor :objects_from_source_failed
|
872
|
+
|
873
|
+
# Objects in the data source that are not transferred because they already exist
|
874
|
+
# in the data sink.
|
875
|
+
# Corresponds to the JSON property `objectsFromSourceSkippedBySync`
|
876
|
+
# @return [Fixnum]
|
877
|
+
attr_accessor :objects_from_source_skipped_by_sync
|
878
|
+
|
879
|
+
def initialize(**args)
|
880
|
+
update!(**args)
|
881
|
+
end
|
882
|
+
|
883
|
+
# Update properties of this object
|
884
|
+
def update!(**args)
|
885
|
+
@bytes_copied_to_sink = args[:bytes_copied_to_sink] if args.key?(:bytes_copied_to_sink)
|
886
|
+
@bytes_deleted_from_sink = args[:bytes_deleted_from_sink] if args.key?(:bytes_deleted_from_sink)
|
887
|
+
@bytes_deleted_from_source = args[:bytes_deleted_from_source] if args.key?(:bytes_deleted_from_source)
|
888
|
+
@bytes_failed_to_delete_from_sink = args[:bytes_failed_to_delete_from_sink] if args.key?(:bytes_failed_to_delete_from_sink)
|
889
|
+
@bytes_found_from_source = args[:bytes_found_from_source] if args.key?(:bytes_found_from_source)
|
890
|
+
@bytes_found_only_from_sink = args[:bytes_found_only_from_sink] if args.key?(:bytes_found_only_from_sink)
|
891
|
+
@bytes_from_source_failed = args[:bytes_from_source_failed] if args.key?(:bytes_from_source_failed)
|
892
|
+
@bytes_from_source_skipped_by_sync = args[:bytes_from_source_skipped_by_sync] if args.key?(:bytes_from_source_skipped_by_sync)
|
893
|
+
@objects_copied_to_sink = args[:objects_copied_to_sink] if args.key?(:objects_copied_to_sink)
|
894
|
+
@objects_deleted_from_sink = args[:objects_deleted_from_sink] if args.key?(:objects_deleted_from_sink)
|
895
|
+
@objects_deleted_from_source = args[:objects_deleted_from_source] if args.key?(:objects_deleted_from_source)
|
896
|
+
@objects_failed_to_delete_from_sink = args[:objects_failed_to_delete_from_sink] if args.key?(:objects_failed_to_delete_from_sink)
|
897
|
+
@objects_found_from_source = args[:objects_found_from_source] if args.key?(:objects_found_from_source)
|
898
|
+
@objects_found_only_from_sink = args[:objects_found_only_from_sink] if args.key?(:objects_found_only_from_sink)
|
899
|
+
@objects_from_source_failed = args[:objects_from_source_failed] if args.key?(:objects_from_source_failed)
|
900
|
+
@objects_from_source_skipped_by_sync = args[:objects_from_source_skipped_by_sync] if args.key?(:objects_from_source_skipped_by_sync)
|
901
|
+
end
|
902
|
+
end
|
903
|
+
|
904
|
+
# This resource represents the configuration of a transfer job that runs
|
905
|
+
# periodically.
|
906
|
+
class TransferJob
|
907
|
+
include Google::Apis::Core::Hashable
|
908
|
+
|
909
|
+
# Output only. The time that the transfer job was created.
|
910
|
+
# Corresponds to the JSON property `creationTime`
|
911
|
+
# @return [String]
|
912
|
+
attr_accessor :creation_time
|
913
|
+
|
914
|
+
# Output only. The time that the transfer job was deleted.
|
915
|
+
# Corresponds to the JSON property `deletionTime`
|
916
|
+
# @return [String]
|
917
|
+
attr_accessor :deletion_time
|
918
|
+
|
919
|
+
# A description provided by the user for the job. Its max length is 1024 bytes
|
920
|
+
# when Unicode-encoded.
|
921
|
+
# Corresponds to the JSON property `description`
|
922
|
+
# @return [String]
|
923
|
+
attr_accessor :description
|
924
|
+
|
925
|
+
# Output only. The time that the transfer job was last modified.
|
926
|
+
# Corresponds to the JSON property `lastModificationTime`
|
927
|
+
# @return [String]
|
928
|
+
attr_accessor :last_modification_time
|
929
|
+
|
930
|
+
# The name of the most recently started TransferOperation of this JobConfig.
|
931
|
+
# Present if and only if at least one TransferOperation has been created for
|
932
|
+
# this JobConfig.
|
933
|
+
# Corresponds to the JSON property `latestOperationName`
|
934
|
+
# @return [String]
|
935
|
+
attr_accessor :latest_operation_name
|
936
|
+
|
937
|
+
# A unique name (within the transfer project) assigned when the job is created.
|
938
|
+
# If this field is empty in a CreateTransferJobRequest, Storage Transfer Service
|
939
|
+
# will assign a unique name. Otherwise, the specified name is used as the unique
|
940
|
+
# name for this job. If the specified name is in use by a job, the creation
|
941
|
+
# request fails with an ALREADY_EXISTS error. This name must start with `"
|
942
|
+
# transferJobs/"` prefix and end with a letter or a number, and should be no
|
943
|
+
# more than 128 characters. Example: `"transferJobs/[A-Za-z0-9-._~]*[A-Za-z0-9]$"
|
944
|
+
# ` Invalid job names will fail with an INVALID_ARGUMENT error.
|
945
|
+
# Corresponds to the JSON property `name`
|
946
|
+
# @return [String]
|
947
|
+
attr_accessor :name
|
948
|
+
|
949
|
+
# Specification to configure notifications published to Cloud Pub/Sub.
|
950
|
+
# Notifications will be published to the customer-provided topic using the
|
951
|
+
# following `PubsubMessage.attributes`: * `"eventType"`: one of the EventType
|
952
|
+
# values * `"payloadFormat"`: one of the PayloadFormat values * `"projectId"`:
|
953
|
+
# the project_id of the `TransferOperation` * `"transferJobName"`: the
|
954
|
+
# transfer_job_name of the `TransferOperation` * `"transferOperationName"`: the
|
955
|
+
# name of the `TransferOperation` The `PubsubMessage.data` will contain a
|
956
|
+
# TransferOperation resource formatted according to the specified `PayloadFormat`
|
957
|
+
# .
|
958
|
+
# Corresponds to the JSON property `notificationConfig`
|
959
|
+
# @return [Google::Apis::StoragetransferV1::NotificationConfig]
|
960
|
+
attr_accessor :notification_config
|
961
|
+
|
962
|
+
# The ID of the Google Cloud Platform Project that owns the job.
|
963
|
+
# Corresponds to the JSON property `projectId`
|
964
|
+
# @return [String]
|
965
|
+
attr_accessor :project_id
|
966
|
+
|
967
|
+
# Transfers can be scheduled to recur or to run just once.
|
968
|
+
# Corresponds to the JSON property `schedule`
|
969
|
+
# @return [Google::Apis::StoragetransferV1::Schedule]
|
970
|
+
attr_accessor :schedule
|
971
|
+
|
972
|
+
# Status of the job. This value MUST be specified for `CreateTransferJobRequests`
|
973
|
+
# . **Note:** The effect of the new job status takes place during a subsequent
|
974
|
+
# job run. For example, if you change the job status from ENABLED to DISABLED,
|
975
|
+
# and an operation spawned by the transfer is running, the status change would
|
976
|
+
# not affect the current operation.
|
977
|
+
# Corresponds to the JSON property `status`
|
978
|
+
# @return [String]
|
979
|
+
attr_accessor :status
|
980
|
+
|
981
|
+
# Configuration for running a transfer.
|
982
|
+
# Corresponds to the JSON property `transferSpec`
|
983
|
+
# @return [Google::Apis::StoragetransferV1::TransferSpec]
|
984
|
+
attr_accessor :transfer_spec
|
985
|
+
|
986
|
+
def initialize(**args)
|
987
|
+
update!(**args)
|
988
|
+
end
|
989
|
+
|
990
|
+
# Update properties of this object
|
991
|
+
def update!(**args)
|
992
|
+
@creation_time = args[:creation_time] if args.key?(:creation_time)
|
993
|
+
@deletion_time = args[:deletion_time] if args.key?(:deletion_time)
|
994
|
+
@description = args[:description] if args.key?(:description)
|
995
|
+
@last_modification_time = args[:last_modification_time] if args.key?(:last_modification_time)
|
996
|
+
@latest_operation_name = args[:latest_operation_name] if args.key?(:latest_operation_name)
|
997
|
+
@name = args[:name] if args.key?(:name)
|
998
|
+
@notification_config = args[:notification_config] if args.key?(:notification_config)
|
999
|
+
@project_id = args[:project_id] if args.key?(:project_id)
|
1000
|
+
@schedule = args[:schedule] if args.key?(:schedule)
|
1001
|
+
@status = args[:status] if args.key?(:status)
|
1002
|
+
@transfer_spec = args[:transfer_spec] if args.key?(:transfer_spec)
|
1003
|
+
end
|
1004
|
+
end
|
1005
|
+
|
1006
|
+
# A description of the execution of a transfer.
|
1007
|
+
class TransferOperation
|
1008
|
+
include Google::Apis::Core::Hashable
|
1009
|
+
|
1010
|
+
# A collection of counters that report the progress of a transfer operation.
|
1011
|
+
# Corresponds to the JSON property `counters`
|
1012
|
+
# @return [Google::Apis::StoragetransferV1::TransferCounters]
|
1013
|
+
attr_accessor :counters
|
1014
|
+
|
1015
|
+
# End time of this transfer execution.
|
1016
|
+
# Corresponds to the JSON property `endTime`
|
1017
|
+
# @return [String]
|
1018
|
+
attr_accessor :end_time
|
1019
|
+
|
1020
|
+
# Summarizes errors encountered with sample error log entries.
|
1021
|
+
# Corresponds to the JSON property `errorBreakdowns`
|
1022
|
+
# @return [Array<Google::Apis::StoragetransferV1::ErrorSummary>]
|
1023
|
+
attr_accessor :error_breakdowns
|
1024
|
+
|
1025
|
+
# A globally unique ID assigned by the system.
|
1026
|
+
# Corresponds to the JSON property `name`
|
1027
|
+
# @return [String]
|
1028
|
+
attr_accessor :name
|
1029
|
+
|
1030
|
+
# Specification to configure notifications published to Cloud Pub/Sub.
|
1031
|
+
# Notifications will be published to the customer-provided topic using the
|
1032
|
+
# following `PubsubMessage.attributes`: * `"eventType"`: one of the EventType
|
1033
|
+
# values * `"payloadFormat"`: one of the PayloadFormat values * `"projectId"`:
|
1034
|
+
# the project_id of the `TransferOperation` * `"transferJobName"`: the
|
1035
|
+
# transfer_job_name of the `TransferOperation` * `"transferOperationName"`: the
|
1036
|
+
# name of the `TransferOperation` The `PubsubMessage.data` will contain a
|
1037
|
+
# TransferOperation resource formatted according to the specified `PayloadFormat`
|
1038
|
+
# .
|
1039
|
+
# Corresponds to the JSON property `notificationConfig`
|
1040
|
+
# @return [Google::Apis::StoragetransferV1::NotificationConfig]
|
1041
|
+
attr_accessor :notification_config
|
1042
|
+
|
1043
|
+
# The ID of the Google Cloud Platform Project that owns the operation.
|
1044
|
+
# Corresponds to the JSON property `projectId`
|
1045
|
+
# @return [String]
|
1046
|
+
attr_accessor :project_id
|
1047
|
+
|
1048
|
+
# Start time of this transfer execution.
|
1049
|
+
# Corresponds to the JSON property `startTime`
|
1050
|
+
# @return [String]
|
1051
|
+
attr_accessor :start_time
|
1052
|
+
|
1053
|
+
# Status of the transfer operation.
|
1054
|
+
# Corresponds to the JSON property `status`
|
1055
|
+
# @return [String]
|
1056
|
+
attr_accessor :status
|
1057
|
+
|
1058
|
+
# The name of the transfer job that triggers this transfer operation.
|
1059
|
+
# Corresponds to the JSON property `transferJobName`
|
1060
|
+
# @return [String]
|
1061
|
+
attr_accessor :transfer_job_name
|
1062
|
+
|
1063
|
+
# Configuration for running a transfer.
|
1064
|
+
# Corresponds to the JSON property `transferSpec`
|
1065
|
+
# @return [Google::Apis::StoragetransferV1::TransferSpec]
|
1066
|
+
attr_accessor :transfer_spec
|
1067
|
+
|
1068
|
+
def initialize(**args)
|
1069
|
+
update!(**args)
|
1070
|
+
end
|
1071
|
+
|
1072
|
+
# Update properties of this object
|
1073
|
+
def update!(**args)
|
1074
|
+
@counters = args[:counters] if args.key?(:counters)
|
1075
|
+
@end_time = args[:end_time] if args.key?(:end_time)
|
1076
|
+
@error_breakdowns = args[:error_breakdowns] if args.key?(:error_breakdowns)
|
1077
|
+
@name = args[:name] if args.key?(:name)
|
1078
|
+
@notification_config = args[:notification_config] if args.key?(:notification_config)
|
1079
|
+
@project_id = args[:project_id] if args.key?(:project_id)
|
1080
|
+
@start_time = args[:start_time] if args.key?(:start_time)
|
1081
|
+
@status = args[:status] if args.key?(:status)
|
1082
|
+
@transfer_job_name = args[:transfer_job_name] if args.key?(:transfer_job_name)
|
1083
|
+
@transfer_spec = args[:transfer_spec] if args.key?(:transfer_spec)
|
1084
|
+
end
|
1085
|
+
end
|
1086
|
+
|
1087
|
+
# TransferOptions define the actions to be performed on objects in a transfer.
|
1088
|
+
class TransferOptions
|
1089
|
+
include Google::Apis::Core::Hashable
|
1090
|
+
|
1091
|
+
# Whether objects should be deleted from the source after they are transferred
|
1092
|
+
# to the sink. **Note:** This option and delete_objects_unique_in_sink are
|
1093
|
+
# mutually exclusive.
|
1094
|
+
# Corresponds to the JSON property `deleteObjectsFromSourceAfterTransfer`
|
1095
|
+
# @return [Boolean]
|
1096
|
+
attr_accessor :delete_objects_from_source_after_transfer
|
1097
|
+
alias_method :delete_objects_from_source_after_transfer?, :delete_objects_from_source_after_transfer
|
1098
|
+
|
1099
|
+
# Whether objects that exist only in the sink should be deleted. **Note:** This
|
1100
|
+
# option and delete_objects_from_source_after_transfer are mutually exclusive.
|
1101
|
+
# Corresponds to the JSON property `deleteObjectsUniqueInSink`
|
1102
|
+
# @return [Boolean]
|
1103
|
+
attr_accessor :delete_objects_unique_in_sink
|
1104
|
+
alias_method :delete_objects_unique_in_sink?, :delete_objects_unique_in_sink
|
1105
|
+
|
1106
|
+
# When to overwrite objects that already exist in the sink. The default is that
|
1107
|
+
# only objects that are different from the source are ovewritten. If true, all
|
1108
|
+
# objects in the sink whose name matches an object in the source will be
|
1109
|
+
# overwritten with the source object.
|
1110
|
+
# Corresponds to the JSON property `overwriteObjectsAlreadyExistingInSink`
|
1111
|
+
# @return [Boolean]
|
1112
|
+
attr_accessor :overwrite_objects_already_existing_in_sink
|
1113
|
+
alias_method :overwrite_objects_already_existing_in_sink?, :overwrite_objects_already_existing_in_sink
|
1114
|
+
|
1115
|
+
def initialize(**args)
|
1116
|
+
update!(**args)
|
1117
|
+
end
|
1118
|
+
|
1119
|
+
# Update properties of this object
|
1120
|
+
def update!(**args)
|
1121
|
+
@delete_objects_from_source_after_transfer = args[:delete_objects_from_source_after_transfer] if args.key?(:delete_objects_from_source_after_transfer)
|
1122
|
+
@delete_objects_unique_in_sink = args[:delete_objects_unique_in_sink] if args.key?(:delete_objects_unique_in_sink)
|
1123
|
+
@overwrite_objects_already_existing_in_sink = args[:overwrite_objects_already_existing_in_sink] if args.key?(:overwrite_objects_already_existing_in_sink)
|
1124
|
+
end
|
1125
|
+
end
|
1126
|
+
|
1127
|
+
# Configuration for running a transfer.
|
1128
|
+
class TransferSpec
|
1129
|
+
include Google::Apis::Core::Hashable
|
1130
|
+
|
1131
|
+
# An AwsS3Data resource can be a data source, but not a data sink. In an
|
1132
|
+
# AwsS3Data resource, an object's name is the S3 object's key name.
|
1133
|
+
# Corresponds to the JSON property `awsS3DataSource`
|
1134
|
+
# @return [Google::Apis::StoragetransferV1::AwsS3Data]
|
1135
|
+
attr_accessor :aws_s3_data_source
|
1136
|
+
|
1137
|
+
# An AzureBlobStorageData resource can be a data source, but not a data sink. An
|
1138
|
+
# AzureBlobStorageData resource represents one Azure container. The storage
|
1139
|
+
# account determines the [Azure endpoint](https://docs.microsoft.com/en-us/azure/
|
1140
|
+
# storage/common/storage-create-storage-account#storage-account-endpoints). In
|
1141
|
+
# an AzureBlobStorageData resource, a blobs's name is the [Azure Blob Storage
|
1142
|
+
# blob's key name](https://docs.microsoft.com/en-us/rest/api/storageservices/
|
1143
|
+
# naming-and-referencing-containers--blobs--and-metadata#blob-names).
|
1144
|
+
# Corresponds to the JSON property `azureBlobStorageDataSource`
|
1145
|
+
# @return [Google::Apis::StoragetransferV1::AzureBlobStorageData]
|
1146
|
+
attr_accessor :azure_blob_storage_data_source
|
1147
|
+
|
1148
|
+
# In a GcsData resource, an object's name is the Cloud Storage object's name and
|
1149
|
+
# its "last modification time" refers to the object's `updated` property of
|
1150
|
+
# Cloud Storage objects, which changes when the content or the metadata of the
|
1151
|
+
# object is updated.
|
1152
|
+
# Corresponds to the JSON property `gcsDataSink`
|
1153
|
+
# @return [Google::Apis::StoragetransferV1::GcsData]
|
1154
|
+
attr_accessor :gcs_data_sink
|
1155
|
+
|
1156
|
+
# In a GcsData resource, an object's name is the Cloud Storage object's name and
|
1157
|
+
# its "last modification time" refers to the object's `updated` property of
|
1158
|
+
# Cloud Storage objects, which changes when the content or the metadata of the
|
1159
|
+
# object is updated.
|
1160
|
+
# Corresponds to the JSON property `gcsDataSource`
|
1161
|
+
# @return [Google::Apis::StoragetransferV1::GcsData]
|
1162
|
+
attr_accessor :gcs_data_source
|
1163
|
+
|
1164
|
+
# An HttpData resource specifies a list of objects on the web to be transferred
|
1165
|
+
# over HTTP. The information of the objects to be transferred is contained in a
|
1166
|
+
# file referenced by a URL. The first line in the file must be `"TsvHttpData-1.0"
|
1167
|
+
# `, which specifies the format of the file. Subsequent lines specify the
|
1168
|
+
# information of the list of objects, one object per list entry. Each entry has
|
1169
|
+
# the following tab-delimited fields: * **HTTP URL** — The location of the
|
1170
|
+
# object. * **Length** — The size of the object in bytes. * **MD5** — The base64-
|
1171
|
+
# encoded MD5 hash of the object. For an example of a valid TSV file, see [
|
1172
|
+
# Transferring data from URLs](https://cloud.google.com/storage-transfer/docs/
|
1173
|
+
# create-url-list). When transferring data based on a URL list, keep the
|
1174
|
+
# following in mind: * When an object located at `http(s)://hostname:port/` is
|
1175
|
+
# transferred to a data sink, the name of the object at the data sink is `/`. *
|
1176
|
+
# If the specified size of an object does not match the actual size of the
|
1177
|
+
# object fetched, the object will not be transferred. * If the specified MD5
|
1178
|
+
# does not match the MD5 computed from the transferred bytes, the object
|
1179
|
+
# transfer will fail. * Ensure that each URL you specify is publicly accessible.
|
1180
|
+
# For example, in Cloud Storage you can [share an object publicly] (https://
|
1181
|
+
# cloud.google.com/storage/docs/cloud-console#_sharingdata) and get a link to it.
|
1182
|
+
# * Storage Transfer Service obeys `robots.txt` rules and requires the source
|
1183
|
+
# HTTP server to support `Range` requests and to return a `Content-Length`
|
1184
|
+
# header in each response. * ObjectConditions have no effect when filtering
|
1185
|
+
# objects to transfer.
|
1186
|
+
# Corresponds to the JSON property `httpDataSource`
|
1187
|
+
# @return [Google::Apis::StoragetransferV1::HttpData]
|
1188
|
+
attr_accessor :http_data_source
|
1189
|
+
|
1190
|
+
# Conditions that determine which objects will be transferred. Applies only to
|
1191
|
+
# Cloud Data Sources such as S3, Azure, and Cloud Storage. The "last
|
1192
|
+
# modification time" refers to the time of the last change to the object's
|
1193
|
+
# content or metadata — specifically, this is the `updated` property of Cloud
|
1194
|
+
# Storage objects, the `LastModified` field of S3 objects, and the `Last-
|
1195
|
+
# Modified` header of Azure blobs.
|
1196
|
+
# Corresponds to the JSON property `objectConditions`
|
1197
|
+
# @return [Google::Apis::StoragetransferV1::ObjectConditions]
|
1198
|
+
attr_accessor :object_conditions
|
1199
|
+
|
1200
|
+
# TransferOptions define the actions to be performed on objects in a transfer.
|
1201
|
+
# Corresponds to the JSON property `transferOptions`
|
1202
|
+
# @return [Google::Apis::StoragetransferV1::TransferOptions]
|
1203
|
+
attr_accessor :transfer_options
|
1204
|
+
|
1205
|
+
def initialize(**args)
|
1206
|
+
update!(**args)
|
1207
|
+
end
|
1208
|
+
|
1209
|
+
# Update properties of this object
|
1210
|
+
def update!(**args)
|
1211
|
+
@aws_s3_data_source = args[:aws_s3_data_source] if args.key?(:aws_s3_data_source)
|
1212
|
+
@azure_blob_storage_data_source = args[:azure_blob_storage_data_source] if args.key?(:azure_blob_storage_data_source)
|
1213
|
+
@gcs_data_sink = args[:gcs_data_sink] if args.key?(:gcs_data_sink)
|
1214
|
+
@gcs_data_source = args[:gcs_data_source] if args.key?(:gcs_data_source)
|
1215
|
+
@http_data_source = args[:http_data_source] if args.key?(:http_data_source)
|
1216
|
+
@object_conditions = args[:object_conditions] if args.key?(:object_conditions)
|
1217
|
+
@transfer_options = args[:transfer_options] if args.key?(:transfer_options)
|
1218
|
+
end
|
1219
|
+
end
|
1220
|
+
|
1221
|
+
# Request passed to UpdateTransferJob.
|
1222
|
+
class UpdateTransferJobRequest
|
1223
|
+
include Google::Apis::Core::Hashable
|
1224
|
+
|
1225
|
+
# Required. The ID of the Google Cloud Platform Console project that owns the
|
1226
|
+
# job.
|
1227
|
+
# Corresponds to the JSON property `projectId`
|
1228
|
+
# @return [String]
|
1229
|
+
attr_accessor :project_id
|
1230
|
+
|
1231
|
+
# This resource represents the configuration of a transfer job that runs
|
1232
|
+
# periodically.
|
1233
|
+
# Corresponds to the JSON property `transferJob`
|
1234
|
+
# @return [Google::Apis::StoragetransferV1::TransferJob]
|
1235
|
+
attr_accessor :transfer_job
|
1236
|
+
|
1237
|
+
# The field mask of the fields in `transferJob` that are to be updated in this
|
1238
|
+
# request. Fields in `transferJob` that can be updated are: description,
|
1239
|
+
# transfer_spec, notification_config, and status. To update the `transfer_spec`
|
1240
|
+
# of the job, a complete transfer specification must be provided. An incomplete
|
1241
|
+
# specification missing any required fields will be rejected with the error
|
1242
|
+
# INVALID_ARGUMENT.
|
1243
|
+
# Corresponds to the JSON property `updateTransferJobFieldMask`
|
1244
|
+
# @return [String]
|
1245
|
+
attr_accessor :update_transfer_job_field_mask
|
1246
|
+
|
1247
|
+
def initialize(**args)
|
1248
|
+
update!(**args)
|
1249
|
+
end
|
1250
|
+
|
1251
|
+
# Update properties of this object
|
1252
|
+
def update!(**args)
|
1253
|
+
@project_id = args[:project_id] if args.key?(:project_id)
|
1254
|
+
@transfer_job = args[:transfer_job] if args.key?(:transfer_job)
|
1255
|
+
@update_transfer_job_field_mask = args[:update_transfer_job_field_mask] if args.key?(:update_transfer_job_field_mask)
|
1256
|
+
end
|
1257
|
+
end
|
1258
|
+
end
|
1259
|
+
end
|
1260
|
+
end
|