google-cloud-filestore-v1 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +167 -0
  4. data/LICENSE.md +201 -0
  5. data/README.md +139 -0
  6. data/lib/google-cloud-filestore-v1.rb +21 -0
  7. data/lib/google/cloud/filestore/v1.rb +38 -0
  8. data/lib/google/cloud/filestore/v1/cloud_filestore_manager.rb +68 -0
  9. data/lib/google/cloud/filestore/v1/cloud_filestore_manager/client.rb +1270 -0
  10. data/lib/google/cloud/filestore/v1/cloud_filestore_manager/credentials.rb +47 -0
  11. data/lib/google/cloud/filestore/v1/cloud_filestore_manager/operations.rb +664 -0
  12. data/lib/google/cloud/filestore/v1/cloud_filestore_manager/paths.rb +88 -0
  13. data/lib/google/cloud/filestore/v1/cloud_filestore_service_pb.rb +197 -0
  14. data/lib/google/cloud/filestore/v1/cloud_filestore_service_services_pb.rb +92 -0
  15. data/lib/google/cloud/filestore/v1/version.rb +28 -0
  16. data/proto_docs/README.md +4 -0
  17. data/proto_docs/google/api/field_behavior.rb +71 -0
  18. data/proto_docs/google/api/resource.rb +283 -0
  19. data/proto_docs/google/cloud/common/operation_metadata.rb +54 -0
  20. data/proto_docs/google/cloud/filestore/v1/cloud_filestore_service.rb +561 -0
  21. data/proto_docs/google/longrunning/operations.rb +164 -0
  22. data/proto_docs/google/protobuf/any.rb +141 -0
  23. data/proto_docs/google/protobuf/duration.rb +98 -0
  24. data/proto_docs/google/protobuf/empty.rb +36 -0
  25. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  26. data/proto_docs/google/protobuf/timestamp.rb +129 -0
  27. data/proto_docs/google/protobuf/wrappers.rb +121 -0
  28. data/proto_docs/google/rpc/status.rb +46 -0
  29. metadata +219 -0
@@ -0,0 +1,283 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # A simple descriptor of a resource type.
23
+ #
24
+ # ResourceDescriptor annotates a resource message (either by means of a
25
+ # protobuf annotation or use in the service config), and associates the
26
+ # resource's schema, the resource type, and the pattern of the resource name.
27
+ #
28
+ # Example:
29
+ #
30
+ # message Topic {
31
+ # // Indicates this message defines a resource schema.
32
+ # // Declares the resource type in the format of {service}/{kind}.
33
+ # // For Kubernetes resources, the format is {api group}/{kind}.
34
+ # option (google.api.resource) = {
35
+ # type: "pubsub.googleapis.com/Topic"
36
+ # name_descriptor: {
37
+ # pattern: "projects/{project}/topics/{topic}"
38
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
39
+ # parent_name_extractor: "projects/{project}"
40
+ # }
41
+ # };
42
+ # }
43
+ #
44
+ # The ResourceDescriptor Yaml config will look like:
45
+ #
46
+ # resources:
47
+ # - type: "pubsub.googleapis.com/Topic"
48
+ # name_descriptor:
49
+ # - pattern: "projects/{project}/topics/{topic}"
50
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
+ # parent_name_extractor: "projects/{project}"
52
+ #
53
+ # Sometimes, resources have multiple patterns, typically because they can
54
+ # live under multiple parents.
55
+ #
56
+ # Example:
57
+ #
58
+ # message LogEntry {
59
+ # option (google.api.resource) = {
60
+ # type: "logging.googleapis.com/LogEntry"
61
+ # name_descriptor: {
62
+ # pattern: "projects/{project}/logs/{log}"
63
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
64
+ # parent_name_extractor: "projects/{project}"
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
+ # }
81
+ # };
82
+ # }
83
+ #
84
+ # The ResourceDescriptor Yaml config will look like:
85
+ #
86
+ # resources:
87
+ # - type: 'logging.googleapis.com/LogEntry'
88
+ # name_descriptor:
89
+ # - pattern: "projects/{project}/logs/{log}"
90
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
91
+ # parent_name_extractor: "projects/{project}"
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"
130
+ # @!attribute [rw] type
131
+ # @return [::String]
132
+ # The resource type. It must be in the format of
133
+ # \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
134
+ # singular and must not include version numbers.
135
+ #
136
+ # Example: `storage.googleapis.com/Bucket`
137
+ #
138
+ # The value of the resource_type_kind must follow the regular expression
139
+ # /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
140
+ # should use PascalCase (UpperCamelCase). The maximum number of
141
+ # characters allowed for the `resource_type_kind` is 100.
142
+ # @!attribute [rw] pattern
143
+ # @return [::Array<::String>]
144
+ # Optional. The relative resource name pattern associated with this resource
145
+ # type. The DNS prefix of the full resource name shouldn't be specified here.
146
+ #
147
+ # The path pattern must follow the syntax, which aligns with HTTP binding
148
+ # syntax:
149
+ #
150
+ # Template = Segment { "/" Segment } ;
151
+ # Segment = LITERAL | Variable ;
152
+ # Variable = "{" LITERAL "}" ;
153
+ #
154
+ # Examples:
155
+ #
156
+ # - "projects/\\{project}/topics/\\{topic}"
157
+ # - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
158
+ #
159
+ # The components in braces correspond to the IDs for each resource in the
160
+ # hierarchy. It is expected that, if multiple patterns are provided,
161
+ # the same component name (e.g. "project") refers to IDs of the same
162
+ # type of resource.
163
+ # @!attribute [rw] name_field
164
+ # @return [::String]
165
+ # Optional. The field on the resource that designates the resource name
166
+ # field. If omitted, this is assumed to be "name".
167
+ # @!attribute [rw] history
168
+ # @return [::Google::Api::ResourceDescriptor::History]
169
+ # Optional. The historical or future-looking state of the resource pattern.
170
+ #
171
+ # Example:
172
+ #
173
+ # // The InspectTemplate message originally only supported resource
174
+ # // names with organization, and project was added later.
175
+ # message InspectTemplate {
176
+ # option (google.api.resource) = {
177
+ # type: "dlp.googleapis.com/InspectTemplate"
178
+ # pattern:
179
+ # "organizations/{organization}/inspectTemplates/{inspect_template}"
180
+ # pattern: "projects/{project}/inspectTemplates/{inspect_template}"
181
+ # history: ORIGINALLY_SINGLE_PATTERN
182
+ # };
183
+ # }
184
+ # @!attribute [rw] plural
185
+ # @return [::String]
186
+ # The plural name used in the resource name and permission names, such as
187
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
188
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
189
+ # concept of the `plural` field in k8s CRD spec
190
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
191
+ #
192
+ # Note: The plural form is required even for singleton resources. See
193
+ # https://aip.dev/156
194
+ # @!attribute [rw] singular
195
+ # @return [::String]
196
+ # The same concept of the `singular` field in k8s CRD spec
197
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
198
+ # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
199
+ # @!attribute [rw] style
200
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
201
+ # Style flag(s) for this resource.
202
+ # These indicate that a resource is expected to conform to a given
203
+ # style. See the specific style flags for additional information.
204
+ class ResourceDescriptor
205
+ include ::Google::Protobuf::MessageExts
206
+ extend ::Google::Protobuf::MessageExts::ClassMethods
207
+
208
+ # A description of the historical or future-looking state of the
209
+ # resource pattern.
210
+ module History
211
+ # The "unset" value.
212
+ HISTORY_UNSPECIFIED = 0
213
+
214
+ # The resource originally had one pattern and launched as such, and
215
+ # additional patterns were added later.
216
+ ORIGINALLY_SINGLE_PATTERN = 1
217
+
218
+ # The resource has one pattern, but the API owner expects to add more
219
+ # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
220
+ # that from being necessary once there are multiple patterns.)
221
+ FUTURE_MULTI_PATTERN = 2
222
+ end
223
+
224
+ # A flag representing a specific style that a resource claims to conform to.
225
+ module Style
226
+ # The unspecified value. Do not use.
227
+ STYLE_UNSPECIFIED = 0
228
+
229
+ # This resource is intended to be "declarative-friendly".
230
+ #
231
+ # Declarative-friendly resources must be more strictly consistent, and
232
+ # setting this to true communicates to tools that this resource should
233
+ # adhere to declarative-friendly expectations.
234
+ #
235
+ # Note: This is used by the API linter (linter.aip.dev) to enable
236
+ # additional checks.
237
+ DECLARATIVE_FRIENDLY = 1
238
+ end
239
+ end
240
+
241
+ # Defines a proto annotation that describes a string field that refers to
242
+ # an API resource.
243
+ # @!attribute [rw] type
244
+ # @return [::String]
245
+ # The resource type that the annotated field references.
246
+ #
247
+ # Example:
248
+ #
249
+ # message Subscription {
250
+ # string topic = 2 [(google.api.resource_reference) = {
251
+ # type: "pubsub.googleapis.com/Topic"
252
+ # }];
253
+ # }
254
+ #
255
+ # Occasionally, a field may reference an arbitrary resource. In this case,
256
+ # APIs use the special value * in their resource reference.
257
+ #
258
+ # Example:
259
+ #
260
+ # message GetIamPolicyRequest {
261
+ # string resource = 2 [(google.api.resource_reference) = {
262
+ # type: "*"
263
+ # }];
264
+ # }
265
+ # @!attribute [rw] child_type
266
+ # @return [::String]
267
+ # The resource type of a child collection that the annotated field
268
+ # references. This is useful for annotating the `parent` field that
269
+ # doesn't have a fixed resource type.
270
+ #
271
+ # Example:
272
+ #
273
+ # message ListLogEntriesRequest {
274
+ # string parent = 1 [(google.api.resource_reference) = {
275
+ # child_type: "logging.googleapis.com/LogEntry"
276
+ # };
277
+ # }
278
+ class ResourceReference
279
+ include ::Google::Protobuf::MessageExts
280
+ extend ::Google::Protobuf::MessageExts::ClassMethods
281
+ end
282
+ end
283
+ end
@@ -0,0 +1,54 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Common
23
+ # Represents the metadata of the long-running operation.
24
+ # @!attribute [r] create_time
25
+ # @return [::Google::Protobuf::Timestamp]
26
+ # Output only. The time the operation was created.
27
+ # @!attribute [r] end_time
28
+ # @return [::Google::Protobuf::Timestamp]
29
+ # Output only. The time the operation finished running.
30
+ # @!attribute [r] target
31
+ # @return [::String]
32
+ # Output only. Server-defined resource path for the target of the operation.
33
+ # @!attribute [r] verb
34
+ # @return [::String]
35
+ # Output only. Name of the verb executed by the operation.
36
+ # @!attribute [r] status_detail
37
+ # @return [::String]
38
+ # Output only. Human-readable status of the operation, if any.
39
+ # @!attribute [r] cancel_requested
40
+ # @return [::Boolean]
41
+ # Output only. Identifies whether the user has requested cancellation
42
+ # of the operation. Operations that have successfully been cancelled
43
+ # have [Operation.error][] value with a [google.rpc.Status.code][] of 1,
44
+ # corresponding to `Code.CANCELLED`.
45
+ # @!attribute [r] api_version
46
+ # @return [::String]
47
+ # Output only. API version used to start the operation.
48
+ class OperationMetadata
49
+ include ::Google::Protobuf::MessageExts
50
+ extend ::Google::Protobuf::MessageExts::ClassMethods
51
+ end
52
+ end
53
+ end
54
+ end
@@ -0,0 +1,561 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Filestore
23
+ module V1
24
+ # Network configuration for the instance.
25
+ # @!attribute [rw] network
26
+ # @return [::String]
27
+ # The name of the Google Compute Engine
28
+ # [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the
29
+ # instance is connected.
30
+ # @!attribute [rw] modes
31
+ # @return [::Array<::Google::Cloud::Filestore::V1::NetworkConfig::AddressMode>]
32
+ # Internet protocol versions for which the instance has IP addresses
33
+ # assigned. For this version, only MODE_IPV4 is supported.
34
+ # @!attribute [rw] reserved_ip_range
35
+ # @return [::String]
36
+ # A /29 CIDR block in one of the
37
+ # [internal IP address
38
+ # ranges](https://www.arin.net/reference/research/statistics/address_filters/)
39
+ # that identifies the range of IP addresses reserved for this instance. For
40
+ # example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap
41
+ # with either existing subnets or assigned IP address ranges for other Cloud
42
+ # Filestore instances in the selected VPC network.
43
+ # @!attribute [r] ip_addresses
44
+ # @return [::Array<::String>]
45
+ # Output only. IPv4 addresses in the format
46
+ # IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or
47
+ # IPv6 addresses in the format
48
+ # `{block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}`.
49
+ class NetworkConfig
50
+ include ::Google::Protobuf::MessageExts
51
+ extend ::Google::Protobuf::MessageExts::ClassMethods
52
+
53
+ # Internet protocol versions supported by Cloud Filestore.
54
+ module AddressMode
55
+ # Internet protocol not set.
56
+ ADDRESS_MODE_UNSPECIFIED = 0
57
+
58
+ # Use the IPv4 internet protocol.
59
+ MODE_IPV4 = 1
60
+ end
61
+ end
62
+
63
+ # File share configuration for the instance.
64
+ # @!attribute [rw] name
65
+ # @return [::String]
66
+ # The name of the file share (must be 16 characters or less).
67
+ # @!attribute [rw] capacity_gb
68
+ # @return [::Integer]
69
+ # File share capacity in gigabytes (GB).
70
+ # Cloud Filestore defines 1 GB as 1024^3 bytes.
71
+ # @!attribute [rw] source_backup
72
+ # @return [::String]
73
+ # The resource name of the backup, in the format
74
+ # `projects/{project_number}/locations/{location_id}/backups/{backup_id}`,
75
+ # that this file share has been restored from.
76
+ # @!attribute [rw] nfs_export_options
77
+ # @return [::Array<::Google::Cloud::Filestore::V1::NfsExportOptions>]
78
+ # Nfs Export Options.
79
+ # There is a limit of 10 export options per file share.
80
+ class FileShareConfig
81
+ include ::Google::Protobuf::MessageExts
82
+ extend ::Google::Protobuf::MessageExts::ClassMethods
83
+ end
84
+
85
+ # NFS export options specifications.
86
+ # @!attribute [rw] ip_ranges
87
+ # @return [::Array<::String>]
88
+ # List of either an IPv4 addresses in the format
89
+ # `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format
90
+ # `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the
91
+ # file share.
92
+ # Overlapping IP ranges are not allowed, both within and across
93
+ # NfsExportOptions. An error will be returned.
94
+ # The limit is 64 IP ranges/addresses for each FileShareConfig among all
95
+ # NfsExportOptions.
96
+ # @!attribute [rw] access_mode
97
+ # @return [::Google::Cloud::Filestore::V1::NfsExportOptions::AccessMode]
98
+ # Either READ_ONLY, for allowing only read requests on the exported
99
+ # directory, or READ_WRITE, for allowing both read and write requests.
100
+ # The default is READ_WRITE.
101
+ # @!attribute [rw] squash_mode
102
+ # @return [::Google::Cloud::Filestore::V1::NfsExportOptions::SquashMode]
103
+ # Either NO_ROOT_SQUASH, for allowing root access on the exported directory,
104
+ # or ROOT_SQUASH, for not allowing root access. The default is
105
+ # NO_ROOT_SQUASH.
106
+ # @!attribute [rw] anon_uid
107
+ # @return [::Integer]
108
+ # An integer representing the anonymous user id with a default value of
109
+ # 65534.
110
+ # Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be
111
+ # returned if this field is specified for other squash_mode settings.
112
+ # @!attribute [rw] anon_gid
113
+ # @return [::Integer]
114
+ # An integer representing the anonymous group id with a default value of
115
+ # 65534.
116
+ # Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be
117
+ # returned if this field is specified for other squash_mode settings.
118
+ class NfsExportOptions
119
+ include ::Google::Protobuf::MessageExts
120
+ extend ::Google::Protobuf::MessageExts::ClassMethods
121
+
122
+ # The access mode.
123
+ module AccessMode
124
+ # AccessMode not set.
125
+ ACCESS_MODE_UNSPECIFIED = 0
126
+
127
+ # The client can only read the file share.
128
+ READ_ONLY = 1
129
+
130
+ # The client can read and write the file share (default).
131
+ READ_WRITE = 2
132
+ end
133
+
134
+ # The squash mode.
135
+ module SquashMode
136
+ # SquashMode not set.
137
+ SQUASH_MODE_UNSPECIFIED = 0
138
+
139
+ # The Root user has root access to the file share (default).
140
+ NO_ROOT_SQUASH = 1
141
+
142
+ # The Root user has squashed access to the anonymous uid/gid.
143
+ ROOT_SQUASH = 2
144
+ end
145
+ end
146
+
147
+ # A Cloud Filestore instance.
148
+ # @!attribute [r] name
149
+ # @return [::String]
150
+ # Output only. The resource name of the instance, in the format
151
+ # `projects/{project}/locations/{location}/instances/{instance}`.
152
+ # @!attribute [rw] description
153
+ # @return [::String]
154
+ # The description of the instance (2048 characters or less).
155
+ # @!attribute [r] state
156
+ # @return [::Google::Cloud::Filestore::V1::Instance::State]
157
+ # Output only. The instance state.
158
+ # @!attribute [r] status_message
159
+ # @return [::String]
160
+ # Output only. Additional information about the instance state, if available.
161
+ # @!attribute [r] create_time
162
+ # @return [::Google::Protobuf::Timestamp]
163
+ # Output only. The time when the instance was created.
164
+ # @!attribute [rw] tier
165
+ # @return [::Google::Cloud::Filestore::V1::Instance::Tier]
166
+ # The service tier of the instance.
167
+ # @!attribute [rw] labels
168
+ # @return [::Google::Protobuf::Map{::String => ::String}]
169
+ # Resource labels to represent user provided metadata.
170
+ # @!attribute [rw] file_shares
171
+ # @return [::Array<::Google::Cloud::Filestore::V1::FileShareConfig>]
172
+ # File system shares on the instance.
173
+ # For this version, only a single file share is supported.
174
+ # @!attribute [rw] networks
175
+ # @return [::Array<::Google::Cloud::Filestore::V1::NetworkConfig>]
176
+ # VPC networks to which the instance is connected.
177
+ # For this version, only a single network is supported.
178
+ # @!attribute [rw] etag
179
+ # @return [::String]
180
+ # Server-specified ETag for the instance resource to prevent simultaneous
181
+ # updates from overwriting each other.
182
+ # @!attribute [r] satisfies_pzs
183
+ # @return [::Google::Protobuf::BoolValue]
184
+ # Output only. Reserved for future use.
185
+ class Instance
186
+ include ::Google::Protobuf::MessageExts
187
+ extend ::Google::Protobuf::MessageExts::ClassMethods
188
+
189
+ # @!attribute [rw] key
190
+ # @return [::String]
191
+ # @!attribute [rw] value
192
+ # @return [::String]
193
+ class LabelsEntry
194
+ include ::Google::Protobuf::MessageExts
195
+ extend ::Google::Protobuf::MessageExts::ClassMethods
196
+ end
197
+
198
+ # The instance state.
199
+ module State
200
+ # State not set.
201
+ STATE_UNSPECIFIED = 0
202
+
203
+ # The instance is being created.
204
+ CREATING = 1
205
+
206
+ # The instance is available for use.
207
+ READY = 2
208
+
209
+ # Work is being done on the instance. You can get further details from the
210
+ # `statusMessage` field of the `Instance` resource.
211
+ REPAIRING = 3
212
+
213
+ # The instance is shutting down.
214
+ DELETING = 4
215
+
216
+ # The instance is experiencing an issue and might be unusable. You can get
217
+ # further details from the `statusMessage` field of the `Instance`
218
+ # resource.
219
+ ERROR = 6
220
+
221
+ # The instance is restoring a backup to an existing file share and may be
222
+ # unusable during this time.
223
+ RESTORING = 7
224
+ end
225
+
226
+ # Available service tiers.
227
+ module Tier
228
+ # Not set.
229
+ TIER_UNSPECIFIED = 0
230
+
231
+ # STANDARD tier.
232
+ STANDARD = 1
233
+
234
+ # PREMIUM tier.
235
+ PREMIUM = 2
236
+
237
+ # BASIC instances offer a maximum capacity of 63.9 TB.
238
+ # BASIC_HDD is an alias for STANDARD Tier, offering economical
239
+ # performance backed by HDD.
240
+ BASIC_HDD = 3
241
+
242
+ # BASIC instances offer a maximum capacity of 63.9 TB.
243
+ # BASIC_SSD is an alias for PREMIUM Tier, and offers improved
244
+ # performance backed by SSD.
245
+ BASIC_SSD = 4
246
+
247
+ # HIGH_SCALE instances offer expanded capacity and performance scaling
248
+ # capabilities.
249
+ HIGH_SCALE_SSD = 5
250
+ end
251
+ end
252
+
253
+ # CreateInstanceRequest creates an instance.
254
+ # @!attribute [rw] parent
255
+ # @return [::String]
256
+ # Required. The instance's project and location, in the format
257
+ # `projects/{project_id}/locations/{location}`. In Cloud Filestore,
258
+ # locations map to GCP zones, for example **us-west1-b**.
259
+ # @!attribute [rw] instance_id
260
+ # @return [::String]
261
+ # Required. The name of the instance to create.
262
+ # The name must be unique for the specified project and location.
263
+ # @!attribute [rw] instance
264
+ # @return [::Google::Cloud::Filestore::V1::Instance]
265
+ # Required. An {::Google::Cloud::Filestore::V1::Instance instance resource}
266
+ class CreateInstanceRequest
267
+ include ::Google::Protobuf::MessageExts
268
+ extend ::Google::Protobuf::MessageExts::ClassMethods
269
+ end
270
+
271
+ # GetInstanceRequest gets the state of an instance.
272
+ # @!attribute [rw] name
273
+ # @return [::String]
274
+ # Required. The instance resource name, in the format
275
+ # `projects/{project_id}/locations/{location}/instances/{instance_id}`.
276
+ class GetInstanceRequest
277
+ include ::Google::Protobuf::MessageExts
278
+ extend ::Google::Protobuf::MessageExts::ClassMethods
279
+ end
280
+
281
+ # UpdateInstanceRequest updates the settings of an instance.
282
+ # @!attribute [rw] update_mask
283
+ # @return [::Google::Protobuf::FieldMask]
284
+ # Mask of fields to update. At least one path must be supplied in this
285
+ # field. The elements of the repeated paths field may only include these
286
+ # fields:
287
+ #
288
+ # * "description"
289
+ # * "file_shares"
290
+ # * "labels"
291
+ # @!attribute [rw] instance
292
+ # @return [::Google::Cloud::Filestore::V1::Instance]
293
+ # Only fields specified in update_mask are updated.
294
+ class UpdateInstanceRequest
295
+ include ::Google::Protobuf::MessageExts
296
+ extend ::Google::Protobuf::MessageExts::ClassMethods
297
+ end
298
+
299
+ # RestoreInstanceRequest restores an existing instances's file share from a
300
+ # backup.
301
+ # @!attribute [rw] name
302
+ # @return [::String]
303
+ # Required. The resource name of the instance, in the format
304
+ # `projects/{project_number}/locations/{location_id}/instances/{instance_id}`.
305
+ # @!attribute [rw] file_share
306
+ # @return [::String]
307
+ # Required. Name of the file share in the Cloud Filestore instance that the backup
308
+ # is being restored to.
309
+ # @!attribute [rw] source_backup
310
+ # @return [::String]
311
+ # The resource name of the backup, in the format
312
+ # `projects/{project_number}/locations/{location_id}/backups/{backup_id}`.
313
+ class RestoreInstanceRequest
314
+ include ::Google::Protobuf::MessageExts
315
+ extend ::Google::Protobuf::MessageExts::ClassMethods
316
+ end
317
+
318
+ # DeleteInstanceRequest deletes an instance.
319
+ # @!attribute [rw] name
320
+ # @return [::String]
321
+ # Required. The instance resource name, in the format
322
+ # `projects/{project_id}/locations/{location}/instances/{instance_id}`
323
+ class DeleteInstanceRequest
324
+ include ::Google::Protobuf::MessageExts
325
+ extend ::Google::Protobuf::MessageExts::ClassMethods
326
+ end
327
+
328
+ # ListInstancesRequest lists instances.
329
+ # @!attribute [rw] parent
330
+ # @return [::String]
331
+ # Required. The project and location for which to retrieve instance information,
332
+ # in the format `projects/{project_id}/locations/{location}`. In Cloud
333
+ # Filestore, locations map to GCP zones, for example **us-west1-b**. To
334
+ # retrieve instance information for all locations, use "-" for the
335
+ # `{location}` value.
336
+ # @!attribute [rw] page_size
337
+ # @return [::Integer]
338
+ # The maximum number of items to return.
339
+ # @!attribute [rw] page_token
340
+ # @return [::String]
341
+ # The next_page_token value to use if there are additional
342
+ # results to retrieve for this list request.
343
+ # @!attribute [rw] order_by
344
+ # @return [::String]
345
+ # Sort results. Supported values are "name", "name desc" or "" (unsorted).
346
+ # @!attribute [rw] filter
347
+ # @return [::String]
348
+ # List filter.
349
+ class ListInstancesRequest
350
+ include ::Google::Protobuf::MessageExts
351
+ extend ::Google::Protobuf::MessageExts::ClassMethods
352
+ end
353
+
354
+ # ListInstancesResponse is the result of ListInstancesRequest.
355
+ # @!attribute [rw] instances
356
+ # @return [::Array<::Google::Cloud::Filestore::V1::Instance>]
357
+ # A list of instances in the project for the specified location.
358
+ #
359
+ # If the `{location}` value in the request is "-", the response contains a
360
+ # list of instances from all locations. If any location is unreachable, the
361
+ # response will only return instances in reachable locations and the
362
+ # "unreachable" field will be populated with a list of unreachable locations.
363
+ # @!attribute [rw] next_page_token
364
+ # @return [::String]
365
+ # The token you can use to retrieve the next page of results. Not returned
366
+ # if there are no more results in the list.
367
+ # @!attribute [rw] unreachable
368
+ # @return [::Array<::String>]
369
+ # Locations that could not be reached.
370
+ class ListInstancesResponse
371
+ include ::Google::Protobuf::MessageExts
372
+ extend ::Google::Protobuf::MessageExts::ClassMethods
373
+ end
374
+
375
+ # A Cloud Filestore backup.
376
+ # @!attribute [r] name
377
+ # @return [::String]
378
+ # Output only. The resource name of the backup, in the format
379
+ # `projects/{project_number}/locations/{location_id}/backups/{backup_id}`.
380
+ # @!attribute [rw] description
381
+ # @return [::String]
382
+ # A description of the backup with 2048 characters or less.
383
+ # Requests with longer descriptions will be rejected.
384
+ # @!attribute [r] state
385
+ # @return [::Google::Cloud::Filestore::V1::Backup::State]
386
+ # Output only. The backup state.
387
+ # @!attribute [r] create_time
388
+ # @return [::Google::Protobuf::Timestamp]
389
+ # Output only. The time when the backup was created.
390
+ # @!attribute [rw] labels
391
+ # @return [::Google::Protobuf::Map{::String => ::String}]
392
+ # Resource labels to represent user provided metadata.
393
+ # @!attribute [r] capacity_gb
394
+ # @return [::Integer]
395
+ # Output only. Capacity of the source file share when the backup was created.
396
+ # @!attribute [r] storage_bytes
397
+ # @return [::Integer]
398
+ # Output only. The size of the storage used by the backup. As backups share storage,
399
+ # this number is expected to change with backup creation/deletion.
400
+ # @!attribute [rw] source_instance
401
+ # @return [::String]
402
+ # The resource name of the source Cloud Filestore instance, in the format
403
+ # `projects/{project_number}/locations/{location_id}/instances/{instance_id}`,
404
+ # used to create this backup.
405
+ # @!attribute [rw] source_file_share
406
+ # @return [::String]
407
+ # Name of the file share in the source Cloud Filestore instance that the
408
+ # backup is created from.
409
+ # @!attribute [r] source_instance_tier
410
+ # @return [::Google::Cloud::Filestore::V1::Instance::Tier]
411
+ # Output only. The service tier of the source Cloud Filestore instance that this backup
412
+ # is created from.
413
+ # @!attribute [r] download_bytes
414
+ # @return [::Integer]
415
+ # Output only. Amount of bytes that will be downloaded if the backup is restored. This
416
+ # may be different than storage bytes, since sequential backups of the same
417
+ # disk will share storage.
418
+ # @!attribute [r] satisfies_pzs
419
+ # @return [::Google::Protobuf::BoolValue]
420
+ # Output only. Reserved for future use.
421
+ class Backup
422
+ include ::Google::Protobuf::MessageExts
423
+ extend ::Google::Protobuf::MessageExts::ClassMethods
424
+
425
+ # @!attribute [rw] key
426
+ # @return [::String]
427
+ # @!attribute [rw] value
428
+ # @return [::String]
429
+ class LabelsEntry
430
+ include ::Google::Protobuf::MessageExts
431
+ extend ::Google::Protobuf::MessageExts::ClassMethods
432
+ end
433
+
434
+ # The backup state.
435
+ module State
436
+ # State not set.
437
+ STATE_UNSPECIFIED = 0
438
+
439
+ # Backup is being created.
440
+ CREATING = 1
441
+
442
+ # Backup has been taken and the operation is being finalized. At this
443
+ # point, changes to the file share will not be reflected in the backup.
444
+ FINALIZING = 2
445
+
446
+ # Backup is available for use.
447
+ READY = 3
448
+
449
+ # Backup is being deleted.
450
+ DELETING = 4
451
+ end
452
+ end
453
+
454
+ # CreateBackupRequest creates a backup.
455
+ # @!attribute [rw] parent
456
+ # @return [::String]
457
+ # Required. The backup's project and location, in the format
458
+ # `projects/{project_number}/locations/{location}`. In Cloud Filestore,
459
+ # backup locations map to GCP regions, for example **us-west1**.
460
+ # @!attribute [rw] backup
461
+ # @return [::Google::Cloud::Filestore::V1::Backup]
462
+ # Required. A {::Google::Cloud::Filestore::V1::Backup backup resource}
463
+ # @!attribute [rw] backup_id
464
+ # @return [::String]
465
+ # Required. The ID to use for the backup.
466
+ # The ID must be unique within the specified project and location.
467
+ #
468
+ # This value must start with a lowercase letter followed by up to 62
469
+ # lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
470
+ # Values that do not match this pattern will trigger an INVALID_ARGUMENT
471
+ # error.
472
+ class CreateBackupRequest
473
+ include ::Google::Protobuf::MessageExts
474
+ extend ::Google::Protobuf::MessageExts::ClassMethods
475
+ end
476
+
477
+ # DeleteBackupRequest deletes a backup.
478
+ # @!attribute [rw] name
479
+ # @return [::String]
480
+ # Required. The backup resource name, in the format
481
+ # `projects/{project_number}/locations/{location}/backups/{backup_id}`
482
+ class DeleteBackupRequest
483
+ include ::Google::Protobuf::MessageExts
484
+ extend ::Google::Protobuf::MessageExts::ClassMethods
485
+ end
486
+
487
+ # UpdateBackupRequest updates description and/or labels for a backup.
488
+ # @!attribute [rw] backup
489
+ # @return [::Google::Cloud::Filestore::V1::Backup]
490
+ # Required. A {::Google::Cloud::Filestore::V1::Backup backup resource}
491
+ # @!attribute [rw] update_mask
492
+ # @return [::Google::Protobuf::FieldMask]
493
+ # Required. Mask of fields to update. At least one path must be supplied in this
494
+ # field.
495
+ class UpdateBackupRequest
496
+ include ::Google::Protobuf::MessageExts
497
+ extend ::Google::Protobuf::MessageExts::ClassMethods
498
+ end
499
+
500
+ # GetBackupRequest gets the state of a backup.
501
+ # @!attribute [rw] name
502
+ # @return [::String]
503
+ # Required. The backup resource name, in the format
504
+ # `projects/{project_number}/locations/{location}/backups/{backup_id}`.
505
+ class GetBackupRequest
506
+ include ::Google::Protobuf::MessageExts
507
+ extend ::Google::Protobuf::MessageExts::ClassMethods
508
+ end
509
+
510
+ # ListBackupsRequest lists backups.
511
+ # @!attribute [rw] parent
512
+ # @return [::String]
513
+ # Required. The project and location for which to retrieve backup information,
514
+ # in the format `projects/{project_number}/locations/{location}`.
515
+ # In Cloud Filestore, backup locations map to GCP regions,
516
+ # for example **us-west1**.
517
+ # To retrieve backup information for all locations, use "-" for the
518
+ # `{location}` value.
519
+ # @!attribute [rw] page_size
520
+ # @return [::Integer]
521
+ # The maximum number of items to return.
522
+ # @!attribute [rw] page_token
523
+ # @return [::String]
524
+ # The next_page_token value to use if there are additional
525
+ # results to retrieve for this list request.
526
+ # @!attribute [rw] order_by
527
+ # @return [::String]
528
+ # Sort results. Supported values are "name", "name desc" or "" (unsorted).
529
+ # @!attribute [rw] filter
530
+ # @return [::String]
531
+ # List filter.
532
+ class ListBackupsRequest
533
+ include ::Google::Protobuf::MessageExts
534
+ extend ::Google::Protobuf::MessageExts::ClassMethods
535
+ end
536
+
537
+ # ListBackupsResponse is the result of ListBackupsRequest.
538
+ # @!attribute [rw] backups
539
+ # @return [::Array<::Google::Cloud::Filestore::V1::Backup>]
540
+ # A list of backups in the project for the specified location.
541
+ #
542
+ # If the `{location}` value in the request is "-", the response contains a
543
+ # list of backups from all locations. If any location is unreachable, the
544
+ # response will only return backups in reachable locations and the
545
+ # "unreachable" field will be populated with a list of unreachable
546
+ # locations.
547
+ # @!attribute [rw] next_page_token
548
+ # @return [::String]
549
+ # The token you can use to retrieve the next page of results. Not returned
550
+ # if there are no more results in the list.
551
+ # @!attribute [rw] unreachable
552
+ # @return [::Array<::String>]
553
+ # Locations that could not be reached.
554
+ class ListBackupsResponse
555
+ include ::Google::Protobuf::MessageExts
556
+ extend ::Google::Protobuf::MessageExts::ClassMethods
557
+ end
558
+ end
559
+ end
560
+ end
561
+ end