google-cloud-network_connectivity-v1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (29) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +169 -0
  4. data/LICENSE.md +201 -0
  5. data/README.md +139 -0
  6. data/lib/google-cloud-network_connectivity-v1.rb +21 -0
  7. data/lib/google/cloud/network_connectivity/v1.rb +38 -0
  8. data/lib/google/cloud/network_connectivity/v1/hub_service.rb +52 -0
  9. data/lib/google/cloud/network_connectivity/v1/hub_service/client.rb +1399 -0
  10. data/lib/google/cloud/network_connectivity/v1/hub_service/credentials.rb +51 -0
  11. data/lib/google/cloud/network_connectivity/v1/hub_service/operations.rb +664 -0
  12. data/lib/google/cloud/network_connectivity/v1/hub_service/paths.rb +143 -0
  13. data/lib/google/cloud/network_connectivity/v1/version.rb +28 -0
  14. data/lib/google/cloud/networkconnectivity/v1/common_pb.rb +31 -0
  15. data/lib/google/cloud/networkconnectivity/v1/hub_pb.rb +158 -0
  16. data/lib/google/cloud/networkconnectivity/v1/hub_services_pb.rb +72 -0
  17. data/proto_docs/README.md +4 -0
  18. data/proto_docs/google/api/field_behavior.rb +71 -0
  19. data/proto_docs/google/api/resource.rb +283 -0
  20. data/proto_docs/google/cloud/networkconnectivity/v1/common.rb +56 -0
  21. data/proto_docs/google/cloud/networkconnectivity/v1/hub.rb +543 -0
  22. data/proto_docs/google/longrunning/operations.rb +164 -0
  23. data/proto_docs/google/protobuf/any.rb +141 -0
  24. data/proto_docs/google/protobuf/duration.rb +98 -0
  25. data/proto_docs/google/protobuf/empty.rb +36 -0
  26. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  27. data/proto_docs/google/protobuf/timestamp.rb +129 -0
  28. data/proto_docs/google/rpc/status.rb +46 -0
  29. metadata +220 -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,56 @@
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 NetworkConnectivity
23
+ module V1
24
+ # Represents the metadata of the long-running operation.
25
+ # @!attribute [r] create_time
26
+ # @return [::Google::Protobuf::Timestamp]
27
+ # Output only. The time the operation was created.
28
+ # @!attribute [r] end_time
29
+ # @return [::Google::Protobuf::Timestamp]
30
+ # Output only. The time the operation finished running.
31
+ # @!attribute [r] target
32
+ # @return [::String]
33
+ # Output only. Server-defined resource path for the target of the operation.
34
+ # @!attribute [r] verb
35
+ # @return [::String]
36
+ # Output only. Name of the verb executed by the operation.
37
+ # @!attribute [r] status_message
38
+ # @return [::String]
39
+ # Output only. Human-readable status of the operation, if any.
40
+ # @!attribute [r] requested_cancellation
41
+ # @return [::Boolean]
42
+ # Output only. Identifies whether the user has requested cancellation
43
+ # of the operation. Operations that have successfully been cancelled
44
+ # have [Operation.error][] value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
45
+ # corresponding to `Code.CANCELLED`.
46
+ # @!attribute [r] api_version
47
+ # @return [::String]
48
+ # Output only. API version used to start the operation.
49
+ class OperationMetadata
50
+ include ::Google::Protobuf::MessageExts
51
+ extend ::Google::Protobuf::MessageExts::ClassMethods
52
+ end
53
+ end
54
+ end
55
+ end
56
+ end
@@ -0,0 +1,543 @@
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 NetworkConnectivity
23
+ module V1
24
+ # A hub is essentially a collection of spokes. A single hub can contain spokes
25
+ # from multiple regions. However, all of a hub's spokes must be associated with
26
+ # resources that reside in the same VPC network.
27
+ # @!attribute [rw] name
28
+ # @return [::String]
29
+ # Immutable. The name of the hub. Hub names must be unique. They use the
30
+ # following form:
31
+ # `projects/{project_number}/locations/global/hubs/{hub_id}`
32
+ # @!attribute [r] create_time
33
+ # @return [::Google::Protobuf::Timestamp]
34
+ # Output only. The time the hub was created.
35
+ # @!attribute [r] update_time
36
+ # @return [::Google::Protobuf::Timestamp]
37
+ # Output only. The time the hub was last updated.
38
+ # @!attribute [rw] labels
39
+ # @return [::Google::Protobuf::Map{::String => ::String}]
40
+ # Optional labels in key:value format. For more information about labels, see
41
+ # [Requirements for
42
+ # labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
43
+ # @!attribute [rw] description
44
+ # @return [::String]
45
+ # An optional description of the hub.
46
+ # @!attribute [r] unique_id
47
+ # @return [::String]
48
+ # Output only. The Google-generated UUID for the hub. This value is unique across all hub
49
+ # resources. If a hub is deleted and another with the same name is created,
50
+ # the new hub is assigned a different unique_id.
51
+ # @!attribute [r] state
52
+ # @return [::Google::Cloud::NetworkConnectivity::V1::State]
53
+ # Output only. The current lifecycle state of this hub.
54
+ class Hub
55
+ include ::Google::Protobuf::MessageExts
56
+ extend ::Google::Protobuf::MessageExts::ClassMethods
57
+
58
+ # @!attribute [rw] key
59
+ # @return [::String]
60
+ # @!attribute [rw] value
61
+ # @return [::String]
62
+ class LabelsEntry
63
+ include ::Google::Protobuf::MessageExts
64
+ extend ::Google::Protobuf::MessageExts::ClassMethods
65
+ end
66
+ end
67
+
68
+ # A spoke represents a connection between your Google Cloud network resources
69
+ # and a non-Google-Cloud network.
70
+ #
71
+ # When you create a spoke, you associate it with a hub. You must also identify
72
+ # a value for exactly one of the following fields:
73
+ #
74
+ # * linked_vpn_tunnels
75
+ # * linked_interconnect_attachments
76
+ # * linked_router_appliance_instances
77
+ # @!attribute [rw] name
78
+ # @return [::String]
79
+ # Immutable. The name of the spoke. Spoke names must be unique. They use the
80
+ # following form:
81
+ # `projects/{project_number}/locations/{region}/spokes/{spoke_id}`
82
+ # @!attribute [r] create_time
83
+ # @return [::Google::Protobuf::Timestamp]
84
+ # Output only. The time the spoke was created.
85
+ # @!attribute [r] update_time
86
+ # @return [::Google::Protobuf::Timestamp]
87
+ # Output only. The time the spoke was last updated.
88
+ # @!attribute [rw] labels
89
+ # @return [::Google::Protobuf::Map{::String => ::String}]
90
+ # Optional labels in key:value format. For more information about labels, see
91
+ # [Requirements for
92
+ # labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements).
93
+ # @!attribute [rw] description
94
+ # @return [::String]
95
+ # An optional description of the spoke.
96
+ # @!attribute [rw] hub
97
+ # @return [::String]
98
+ # Immutable. The URI of the hub that this spoke is attached to.
99
+ # @!attribute [rw] linked_vpn_tunnels
100
+ # @return [::Google::Cloud::NetworkConnectivity::V1::LinkedVpnTunnels]
101
+ # VPN tunnels that are associated with the spoke.
102
+ # @!attribute [rw] linked_interconnect_attachments
103
+ # @return [::Google::Cloud::NetworkConnectivity::V1::LinkedInterconnectAttachments]
104
+ # VLAN attachments that are associated with the spoke.
105
+ # @!attribute [rw] linked_router_appliance_instances
106
+ # @return [::Google::Cloud::NetworkConnectivity::V1::LinkedRouterApplianceInstances]
107
+ # Router appliance instances that are associated with the spoke.
108
+ # @!attribute [r] unique_id
109
+ # @return [::String]
110
+ # Output only. The Google-generated UUID for the spoke. This value is unique across all
111
+ # spoke resources. If a spoke is deleted and another with the same name is
112
+ # created, the new spoke is assigned a different unique_id.
113
+ # @!attribute [r] state
114
+ # @return [::Google::Cloud::NetworkConnectivity::V1::State]
115
+ # Output only. The current lifecycle state of this spoke.
116
+ class Spoke
117
+ include ::Google::Protobuf::MessageExts
118
+ extend ::Google::Protobuf::MessageExts::ClassMethods
119
+
120
+ # @!attribute [rw] key
121
+ # @return [::String]
122
+ # @!attribute [rw] value
123
+ # @return [::String]
124
+ class LabelsEntry
125
+ include ::Google::Protobuf::MessageExts
126
+ extend ::Google::Protobuf::MessageExts::ClassMethods
127
+ end
128
+ end
129
+
130
+ # Request for {::Google::Cloud::NetworkConnectivity::V1::HubService::Client#list_hubs HubService.ListHubs} method.
131
+ # @!attribute [rw] parent
132
+ # @return [::String]
133
+ # Required. The parent resource's name.
134
+ # @!attribute [rw] page_size
135
+ # @return [::Integer]
136
+ # The maximum number of results per page that should be returned.
137
+ # @!attribute [rw] page_token
138
+ # @return [::String]
139
+ # The page token.
140
+ # @!attribute [rw] filter
141
+ # @return [::String]
142
+ # An expression that filters the results listed in the response.
143
+ # @!attribute [rw] order_by
144
+ # @return [::String]
145
+ # Sort the results by a certain order.
146
+ class ListHubsRequest
147
+ include ::Google::Protobuf::MessageExts
148
+ extend ::Google::Protobuf::MessageExts::ClassMethods
149
+ end
150
+
151
+ # Response for {::Google::Cloud::NetworkConnectivity::V1::HubService::Client#list_hubs HubService.ListHubs} method.
152
+ # @!attribute [rw] hubs
153
+ # @return [::Array<::Google::Cloud::NetworkConnectivity::V1::Hub>]
154
+ # The requested hubs.
155
+ # @!attribute [rw] next_page_token
156
+ # @return [::String]
157
+ # The next pagination token in the List response. It should be used as
158
+ # page_token for the following request. An empty value means no more result.
159
+ # @!attribute [rw] unreachable
160
+ # @return [::Array<::String>]
161
+ # Locations that could not be reached.
162
+ class ListHubsResponse
163
+ include ::Google::Protobuf::MessageExts
164
+ extend ::Google::Protobuf::MessageExts::ClassMethods
165
+ end
166
+
167
+ # Request for {::Google::Cloud::NetworkConnectivity::V1::HubService::Client#get_hub HubService.GetHub} method.
168
+ # @!attribute [rw] name
169
+ # @return [::String]
170
+ # Required. The name of the hub resource to get.
171
+ class GetHubRequest
172
+ include ::Google::Protobuf::MessageExts
173
+ extend ::Google::Protobuf::MessageExts::ClassMethods
174
+ end
175
+
176
+ # Request for {::Google::Cloud::NetworkConnectivity::V1::HubService::Client#create_hub HubService.CreateHub} method.
177
+ # @!attribute [rw] parent
178
+ # @return [::String]
179
+ # Required. The parent resource.
180
+ # @!attribute [rw] hub_id
181
+ # @return [::String]
182
+ # Optional. A unique identifier for the hub.
183
+ # @!attribute [rw] hub
184
+ # @return [::Google::Cloud::NetworkConnectivity::V1::Hub]
185
+ # Required. The initial values for a new hub.
186
+ # @!attribute [rw] request_id
187
+ # @return [::String]
188
+ # Optional. A unique request ID (optional). If you specify this ID, you can use it
189
+ # in cases when you need to retry your request. When you need to retry, this
190
+ # ID lets the server know that it can ignore the request if it has already
191
+ # been completed. The server guarantees that for at least 60 minutes after
192
+ # the first request.
193
+ #
194
+ # For example, consider a situation where you make an initial request and
195
+ # the request times out. If you make the request again with the same request
196
+ # ID, the server can check to see whether the original operation
197
+ # was received. If it was, the server ignores the second request. This
198
+ # behavior prevents clients from mistakenly creating duplicate commitments.
199
+ #
200
+ # The request ID must be a valid UUID, with the exception that zero UUID is
201
+ # not supported (00000000-0000-0000-0000-000000000000).
202
+ class CreateHubRequest
203
+ include ::Google::Protobuf::MessageExts
204
+ extend ::Google::Protobuf::MessageExts::ClassMethods
205
+ end
206
+
207
+ # Request for {::Google::Cloud::NetworkConnectivity::V1::HubService::Client#update_hub HubService.UpdateHub} method.
208
+ # @!attribute [rw] update_mask
209
+ # @return [::Google::Protobuf::FieldMask]
210
+ # Optional. In the case of an update to an existing hub, field mask is used to specify
211
+ # the fields to be overwritten. The fields specified in the update_mask are
212
+ # relative to the resource, not the full request. A field is overwritten if
213
+ # it is in the mask. If the user does not provide a mask, then all fields are
214
+ # overwritten.
215
+ # @!attribute [rw] hub
216
+ # @return [::Google::Cloud::NetworkConnectivity::V1::Hub]
217
+ # Required. The state that the hub should be in after the update.
218
+ # @!attribute [rw] request_id
219
+ # @return [::String]
220
+ # Optional. A unique request ID (optional). If you specify this ID, you can use it
221
+ # in cases when you need to retry your request. When you need to retry, this
222
+ # ID lets the server know that it can ignore the request if it has already
223
+ # been completed. The server guarantees that for at least 60 minutes after
224
+ # the first request.
225
+ #
226
+ # For example, consider a situation where you make an initial request and
227
+ # the request times out. If you make the request again with the same request
228
+ # ID, the server can check to see whether the original operation
229
+ # was received. If it was, the server ignores the second request. This
230
+ # behavior prevents clients from mistakenly creating duplicate commitments.
231
+ #
232
+ # The request ID must be a valid UUID, with the exception that zero UUID is
233
+ # not supported (00000000-0000-0000-0000-000000000000).
234
+ class UpdateHubRequest
235
+ include ::Google::Protobuf::MessageExts
236
+ extend ::Google::Protobuf::MessageExts::ClassMethods
237
+ end
238
+
239
+ # The request for {::Google::Cloud::NetworkConnectivity::V1::HubService::Client#delete_hub HubService.DeleteHub}.
240
+ # @!attribute [rw] name
241
+ # @return [::String]
242
+ # Required. The name of the hub to delete.
243
+ # @!attribute [rw] request_id
244
+ # @return [::String]
245
+ # Optional. A unique request ID (optional). If you specify this ID, you can use it
246
+ # in cases when you need to retry your request. When you need to retry, this
247
+ # ID lets the server know that it can ignore the request if it has already
248
+ # been completed. The server guarantees that for at least 60 minutes after
249
+ # the first request.
250
+ #
251
+ # For example, consider a situation where you make an initial request and
252
+ # the request times out. If you make the request again with the same request
253
+ # ID, the server can check to see whether the original operation
254
+ # was received. If it was, the server ignores the second request. This
255
+ # behavior prevents clients from mistakenly creating duplicate commitments.
256
+ #
257
+ # The request ID must be a valid UUID, with the exception that zero UUID is
258
+ # not supported (00000000-0000-0000-0000-000000000000).
259
+ class DeleteHubRequest
260
+ include ::Google::Protobuf::MessageExts
261
+ extend ::Google::Protobuf::MessageExts::ClassMethods
262
+ end
263
+
264
+ # The request for {::Google::Cloud::NetworkConnectivity::V1::HubService::Client#list_spokes HubService.ListSpokes}.
265
+ # @!attribute [rw] parent
266
+ # @return [::String]
267
+ # Required. The parent resource.
268
+ # @!attribute [rw] page_size
269
+ # @return [::Integer]
270
+ # The maximum number of results per page that should be returned.
271
+ # @!attribute [rw] page_token
272
+ # @return [::String]
273
+ # The page token.
274
+ # @!attribute [rw] filter
275
+ # @return [::String]
276
+ # An expression that filters the results listed in the response.
277
+ # @!attribute [rw] order_by
278
+ # @return [::String]
279
+ # Sort the results by a certain order.
280
+ class ListSpokesRequest
281
+ include ::Google::Protobuf::MessageExts
282
+ extend ::Google::Protobuf::MessageExts::ClassMethods
283
+ end
284
+
285
+ # The response for {::Google::Cloud::NetworkConnectivity::V1::HubService::Client#list_spokes HubService.ListSpokes}.
286
+ # @!attribute [rw] spokes
287
+ # @return [::Array<::Google::Cloud::NetworkConnectivity::V1::Spoke>]
288
+ # The requested spokes.
289
+ # @!attribute [rw] next_page_token
290
+ # @return [::String]
291
+ # The next pagination token in the List response. It should be used as
292
+ # page_token for the following request. An empty value means no more result.
293
+ # @!attribute [rw] unreachable
294
+ # @return [::Array<::String>]
295
+ # Locations that could not be reached.
296
+ class ListSpokesResponse
297
+ include ::Google::Protobuf::MessageExts
298
+ extend ::Google::Protobuf::MessageExts::ClassMethods
299
+ end
300
+
301
+ # The request for {::Google::Cloud::NetworkConnectivity::V1::HubService::Client#get_spoke HubService.GetSpoke}.
302
+ # @!attribute [rw] name
303
+ # @return [::String]
304
+ # Required. The name of the spoke resource.
305
+ class GetSpokeRequest
306
+ include ::Google::Protobuf::MessageExts
307
+ extend ::Google::Protobuf::MessageExts::ClassMethods
308
+ end
309
+
310
+ # The request for {::Google::Cloud::NetworkConnectivity::V1::HubService::Client#create_spoke HubService.CreateSpoke}.
311
+ # @!attribute [rw] parent
312
+ # @return [::String]
313
+ # Required. The parent resource.
314
+ # @!attribute [rw] spoke_id
315
+ # @return [::String]
316
+ # Optional. Unique id for the spoke to create.
317
+ # @!attribute [rw] spoke
318
+ # @return [::Google::Cloud::NetworkConnectivity::V1::Spoke]
319
+ # Required. The initial values for a new spoke.
320
+ # @!attribute [rw] request_id
321
+ # @return [::String]
322
+ # Optional. A unique request ID (optional). If you specify this ID, you can use it
323
+ # in cases when you need to retry your request. When you need to retry, this
324
+ # ID lets the server know that it can ignore the request if it has already
325
+ # been completed. The server guarantees that for at least 60 minutes after
326
+ # the first request.
327
+ #
328
+ # For example, consider a situation where you make an initial request and
329
+ # the request times out. If you make the request again with the same request
330
+ # ID, the server can check to see whether the original operation
331
+ # was received. If it was, the server ignores the second request. This
332
+ # behavior prevents clients from mistakenly creating duplicate commitments.
333
+ #
334
+ # The request ID must be a valid UUID, with the exception that zero UUID is
335
+ # not supported (00000000-0000-0000-0000-000000000000).
336
+ class CreateSpokeRequest
337
+ include ::Google::Protobuf::MessageExts
338
+ extend ::Google::Protobuf::MessageExts::ClassMethods
339
+ end
340
+
341
+ # Request for {::Google::Cloud::NetworkConnectivity::V1::HubService::Client#update_spoke HubService.UpdateSpoke} method.
342
+ # @!attribute [rw] update_mask
343
+ # @return [::Google::Protobuf::FieldMask]
344
+ # Optional. In the case of an update to an existing spoke, field mask is used to
345
+ # specify the fields to be overwritten. The fields specified in the
346
+ # update_mask are relative to the resource, not the full request. A field is
347
+ # overwritten if it is in the mask. If the user does not provide a mask, then
348
+ # all fields are overwritten.
349
+ # @!attribute [rw] spoke
350
+ # @return [::Google::Cloud::NetworkConnectivity::V1::Spoke]
351
+ # Required. The state that the spoke should be in after the update.
352
+ # @!attribute [rw] request_id
353
+ # @return [::String]
354
+ # Optional. A unique request ID (optional). If you specify this ID, you can use it
355
+ # in cases when you need to retry your request. When you need to retry, this
356
+ # ID lets the server know that it can ignore the request if it has already
357
+ # been completed. The server guarantees that for at least 60 minutes after
358
+ # the first request.
359
+ #
360
+ # For example, consider a situation where you make an initial request and
361
+ # the request times out. If you make the request again with the same request
362
+ # ID, the server can check to see whether the original operation
363
+ # was received. If it was, the server ignores the second request. This
364
+ # behavior prevents clients from mistakenly creating duplicate commitments.
365
+ #
366
+ # The request ID must be a valid UUID, with the exception that zero UUID is
367
+ # not supported (00000000-0000-0000-0000-000000000000).
368
+ class UpdateSpokeRequest
369
+ include ::Google::Protobuf::MessageExts
370
+ extend ::Google::Protobuf::MessageExts::ClassMethods
371
+ end
372
+
373
+ # The request for {::Google::Cloud::NetworkConnectivity::V1::HubService::Client#delete_spoke HubService.DeleteSpoke}.
374
+ # @!attribute [rw] name
375
+ # @return [::String]
376
+ # Required. The name of the spoke to delete.
377
+ # @!attribute [rw] request_id
378
+ # @return [::String]
379
+ # Optional. A unique request ID (optional). If you specify this ID, you can use it
380
+ # in cases when you need to retry your request. When you need to retry, this
381
+ # ID lets the server know that it can ignore the request if it has already
382
+ # been completed. The server guarantees that for at least 60 minutes after
383
+ # the first request.
384
+ #
385
+ # For example, consider a situation where you make an initial request and
386
+ # the request times out. If you make the request again with the same request
387
+ # ID, the server can check to see whether the original operation
388
+ # was received. If it was, the server ignores the second request. This
389
+ # behavior prevents clients from mistakenly creating duplicate commitments.
390
+ #
391
+ # The request ID must be a valid UUID, with the exception that zero UUID is
392
+ # not supported (00000000-0000-0000-0000-000000000000).
393
+ class DeleteSpokeRequest
394
+ include ::Google::Protobuf::MessageExts
395
+ extend ::Google::Protobuf::MessageExts::ClassMethods
396
+ end
397
+
398
+ # The request for {::Google::Cloud::NetworkConnectivity::V1::HubService::Client#deactivate_spoke HubService.DeactivateSpoke}.
399
+ # @!attribute [rw] name
400
+ # @return [::String]
401
+ # Required. The name of the spoke to deactivate.
402
+ # @!attribute [rw] request_id
403
+ # @return [::String]
404
+ # Optional. A unique request ID (optional). If you specify this ID, you can use it
405
+ # in cases when you need to retry your request. When you need to retry, this
406
+ # ID lets the server know that it can ignore the request if it has already
407
+ # been completed. The server guarantees that for at least 60 minutes after
408
+ # the first request.
409
+ #
410
+ # For example, consider a situation where you make an initial request and
411
+ # the request times out. If you make the request again with the same request
412
+ # ID, the server can check to see whether the original operation
413
+ # was received. If it was, the server ignores the second request. This
414
+ # behavior prevents clients from mistakenly creating duplicate commitments.
415
+ #
416
+ # The request ID must be a valid UUID, with the exception that zero UUID is
417
+ # not supported (00000000-0000-0000-0000-000000000000).
418
+ class DeactivateSpokeRequest
419
+ include ::Google::Protobuf::MessageExts
420
+ extend ::Google::Protobuf::MessageExts::ClassMethods
421
+ end
422
+
423
+ # The request for {::Google::Cloud::NetworkConnectivity::V1::HubService::Client#activate_spoke HubService.ActivateSpoke}.
424
+ # @!attribute [rw] name
425
+ # @return [::String]
426
+ # Required. The name of the spoke to activate.
427
+ # @!attribute [rw] request_id
428
+ # @return [::String]
429
+ # Optional. A unique request ID (optional). If you specify this ID, you can use it
430
+ # in cases when you need to retry your request. When you need to retry, this
431
+ # ID lets the server know that it can ignore the request if it has already
432
+ # been completed. The server guarantees that for at least 60 minutes after
433
+ # the first request.
434
+ #
435
+ # For example, consider a situation where you make an initial request and
436
+ # the request times out. If you make the request again with the same request
437
+ # ID, the server can check to see whether the original operation
438
+ # was received. If it was, the server ignores the second request. This
439
+ # behavior prevents clients from mistakenly creating duplicate commitments.
440
+ #
441
+ # The request ID must be a valid UUID, with the exception that zero UUID is
442
+ # not supported (00000000-0000-0000-0000-000000000000).
443
+ class ActivateSpokeRequest
444
+ include ::Google::Protobuf::MessageExts
445
+ extend ::Google::Protobuf::MessageExts::ClassMethods
446
+ end
447
+
448
+ # A collection of Cloud VPN tunnel resources. These resources should be
449
+ # redundant HA VPN tunnels that all advertise the same prefixes to Google
450
+ # Cloud. Alternatively, in a passive/active configuration, all tunnels
451
+ # should be capable of advertising the same prefixes.
452
+ # @!attribute [rw] uris
453
+ # @return [::Array<::String>]
454
+ # The URIs of linked VPN tunnel resources.
455
+ # @!attribute [rw] site_to_site_data_transfer
456
+ # @return [::Boolean]
457
+ # A value that controls whether site-to-site data transfer is enabled for
458
+ # these resources. If true, routes are propagated between the spoke
459
+ # associated with these resources and other spokes in the hub that have data
460
+ # transfer enabled. If false, the spoke associated with these resources
461
+ # provides connectivity only between the external site and Google Cloud. In
462
+ # regions where data transfer is unsupported, you cannot set this field
463
+ # to true.
464
+ class LinkedVpnTunnels
465
+ include ::Google::Protobuf::MessageExts
466
+ extend ::Google::Protobuf::MessageExts::ClassMethods
467
+ end
468
+
469
+ # A collection of VLAN attachment resources. These resources should
470
+ # be redundant attachments that all advertise the same prefixes to Google
471
+ # Cloud. Alternatively, in active/passive configurations, all attachments
472
+ # should be capable of advertising the same prefixes.
473
+ # @!attribute [rw] uris
474
+ # @return [::Array<::String>]
475
+ # The URIs of linked interconnect attachment resources
476
+ # @!attribute [rw] site_to_site_data_transfer
477
+ # @return [::Boolean]
478
+ # A value that controls whether site-to-site data transfer is enabled for
479
+ # these resources. If true, routes are propagated between the spoke
480
+ # associated with these resources and other spokes in the hub that have data
481
+ # transfer enabled. If false, the spoke associated with these resources
482
+ # provides connectivity only between the external site and Google Cloud. In
483
+ # regions where data transfer is unsupported, you cannot set this field
484
+ # to true.
485
+ class LinkedInterconnectAttachments
486
+ include ::Google::Protobuf::MessageExts
487
+ extend ::Google::Protobuf::MessageExts::ClassMethods
488
+ end
489
+
490
+ # A collection of router appliance instances. If you have multiple router
491
+ # appliance instances connected to the same site, they should all be attached
492
+ # to the same spoke.
493
+ # @!attribute [rw] instances
494
+ # @return [::Array<::Google::Cloud::NetworkConnectivity::V1::RouterApplianceInstance>]
495
+ # The list of router appliance instances.
496
+ # @!attribute [rw] site_to_site_data_transfer
497
+ # @return [::Boolean]
498
+ # A value that controls whether site-to-site data transfer is enabled for
499
+ # these resources. If true, routes are propagated between the spoke
500
+ # associated with these resources and other spokes in the hub that have data
501
+ # transfer enabled. If false, the spoke associated with these resources
502
+ # provides connectivity only between the external site and Google Cloud. In
503
+ # regions where data transfer is unsupported, you cannot set this field
504
+ # to true.
505
+ class LinkedRouterApplianceInstances
506
+ include ::Google::Protobuf::MessageExts
507
+ extend ::Google::Protobuf::MessageExts::ClassMethods
508
+ end
509
+
510
+ # A router appliance instance is a Compute Engine virtual machine (VM) instance
511
+ # that acts as a BGP speaker. A router appliance instance is specified by the
512
+ # URI of the VM and the internal IP address of one of the VM's network
513
+ # interfaces.
514
+ # @!attribute [rw] virtual_machine
515
+ # @return [::String]
516
+ # The URI of the VM.
517
+ # @!attribute [rw] ip_address
518
+ # @return [::String]
519
+ # The IP address on the VM to use for peering.
520
+ class RouterApplianceInstance
521
+ include ::Google::Protobuf::MessageExts
522
+ extend ::Google::Protobuf::MessageExts::ClassMethods
523
+ end
524
+
525
+ # The State enum represents the lifecycle stage of a Network Connectivity
526
+ # Center resource.
527
+ module State
528
+ # No state information available
529
+ STATE_UNSPECIFIED = 0
530
+
531
+ # The resource's create operation is in progress
532
+ CREATING = 1
533
+
534
+ # The resource is active
535
+ ACTIVE = 2
536
+
537
+ # The resource's Delete operation is in progress
538
+ DELETING = 3
539
+ end
540
+ end
541
+ end
542
+ end
543
+ end