google-cloud-network_management-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 (31) 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-network_management-v1.rb +21 -0
  7. data/lib/google/cloud/network_management/v1.rb +38 -0
  8. data/lib/google/cloud/network_management/v1/reachability_service.rb +57 -0
  9. data/lib/google/cloud/network_management/v1/reachability_service/client.rb +846 -0
  10. data/lib/google/cloud/network_management/v1/reachability_service/credentials.rb +47 -0
  11. data/lib/google/cloud/network_management/v1/reachability_service/operations.rb +655 -0
  12. data/lib/google/cloud/network_management/v1/reachability_service/paths.rb +50 -0
  13. data/lib/google/cloud/network_management/v1/version.rb +28 -0
  14. data/lib/google/cloud/networkmanagement/v1/connectivity_test_pb.rb +70 -0
  15. data/lib/google/cloud/networkmanagement/v1/reachability_pb.rb +73 -0
  16. data/lib/google/cloud/networkmanagement/v1/reachability_services_pb.rb +100 -0
  17. data/lib/google/cloud/networkmanagement/v1/trace_pb.rb +330 -0
  18. data/proto_docs/README.md +4 -0
  19. data/proto_docs/google/api/field_behavior.rb +71 -0
  20. data/proto_docs/google/api/resource.rb +283 -0
  21. data/proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb +232 -0
  22. data/proto_docs/google/cloud/networkmanagement/v1/reachability.rb +174 -0
  23. data/proto_docs/google/cloud/networkmanagement/v1/trace.rb +937 -0
  24. data/proto_docs/google/longrunning/operations.rb +164 -0
  25. data/proto_docs/google/protobuf/any.rb +141 -0
  26. data/proto_docs/google/protobuf/duration.rb +98 -0
  27. data/proto_docs/google/protobuf/empty.rb +36 -0
  28. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  29. data/proto_docs/google/protobuf/timestamp.rb +129 -0
  30. data/proto_docs/google/rpc/status.rb +46 -0
  31. metadata +221 -0
@@ -0,0 +1,4 @@
1
+ # Network Management V1 Protocol Buffer Documentation
2
+
3
+ These files are for the YARD documentation of the generated protobuf files.
4
+ They are not intended to be required or loaded at runtime.
@@ -0,0 +1,71 @@
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
+ # An indicator of the behavior of a given field (for example, that a field
23
+ # is required in requests, or given as output but ignored as input).
24
+ # This **does not** change the behavior in protocol buffers itself; it only
25
+ # denotes the behavior and may affect how API tooling handles the field.
26
+ #
27
+ # Note: This enum **may** receive new values in the future.
28
+ module FieldBehavior
29
+ # Conventional default for enums. Do not use this.
30
+ FIELD_BEHAVIOR_UNSPECIFIED = 0
31
+
32
+ # Specifically denotes a field as optional.
33
+ # While all fields in protocol buffers are optional, this may be specified
34
+ # for emphasis if appropriate.
35
+ OPTIONAL = 1
36
+
37
+ # Denotes a field as required.
38
+ # This indicates that the field **must** be provided as part of the request,
39
+ # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
40
+ REQUIRED = 2
41
+
42
+ # Denotes a field as output only.
43
+ # This indicates that the field is provided in responses, but including the
44
+ # field in a request does nothing (the server *must* ignore it and
45
+ # *must not* throw an error as a result of the field's presence).
46
+ OUTPUT_ONLY = 3
47
+
48
+ # Denotes a field as input only.
49
+ # This indicates that the field is provided in requests, and the
50
+ # corresponding field is not included in output.
51
+ INPUT_ONLY = 4
52
+
53
+ # Denotes a field as immutable.
54
+ # This indicates that the field may be set once in a request to create a
55
+ # resource, but may not be changed thereafter.
56
+ IMMUTABLE = 5
57
+
58
+ # Denotes that a (repeated) field is an unordered list.
59
+ # This indicates that the service may provide the elements of the list
60
+ # in any arbitrary order, rather than the order the user originally
61
+ # provided. Additionally, the list's order may or may not be stable.
62
+ UNORDERED_LIST = 6
63
+
64
+ # Denotes that this field returns a non-empty default value if not set.
65
+ # This indicates that if the user provides the empty value in a request,
66
+ # a non-empty value will be returned. The user will not be aware of what
67
+ # non-empty value to expect.
68
+ NON_EMPTY_DEFAULT = 7
69
+ end
70
+ end
71
+ end
@@ -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,232 @@
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 NetworkManagement
23
+ module V1
24
+ # A Connectivity Test for a network reachability analysis.
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # Required. Unique name of the resource using the form:
28
+ # `projects/{project_id}/locations/global/connectivityTests/{test_id}`
29
+ # @!attribute [rw] description
30
+ # @return [::String]
31
+ # The user-supplied description of the Connectivity Test.
32
+ # Maximum of 512 characters.
33
+ # @!attribute [rw] source
34
+ # @return [::Google::Cloud::NetworkManagement::V1::Endpoint]
35
+ # Required. Source specification of the Connectivity Test.
36
+ #
37
+ # You can use a combination of source IP address, virtual machine
38
+ # (VM) instance, or Compute Engine network to uniquely identify
39
+ # the source location.
40
+ #
41
+ # Examples:
42
+ # If the source IP address is an internal IP address within a Google Cloud
43
+ # Virtual Private Cloud (VPC) network, then you must also specify the VPC
44
+ # network. Otherwise, specify the VM instance, which already contains its
45
+ # internal IP address and VPC network information.
46
+ #
47
+ # If the source of the test is within an on-premises network, then you must
48
+ # provide the destination VPC network.
49
+ #
50
+ # If the source endpoint is a Compute Engine VM instance with multiple
51
+ # network interfaces, the instance itself is not sufficient to identify the
52
+ # endpoint. So, you must also specify the source IP address or VPC network.
53
+ #
54
+ # A reachability analysis proceeds even if the source location is
55
+ # ambiguous. However, the test result may include endpoints that you don't
56
+ # intend to test.
57
+ # @!attribute [rw] destination
58
+ # @return [::Google::Cloud::NetworkManagement::V1::Endpoint]
59
+ # Required. Destination specification of the Connectivity Test.
60
+ #
61
+ # You can use a combination of destination IP address, Compute Engine
62
+ # VM instance, or VPC network to uniquely identify the destination
63
+ # location.
64
+ #
65
+ # Even if the destination IP address is not unique, the source IP
66
+ # location is unique. Usually, the analysis can infer the destination
67
+ # endpoint from route information.
68
+ #
69
+ # If the destination you specify is a VM instance and the instance has
70
+ # multiple network interfaces, then you must also specify either
71
+ # a destination IP address or VPC network to identify the destination
72
+ # interface.
73
+ #
74
+ # A reachability analysis proceeds even if the destination location is
75
+ # ambiguous. However, the result can include endpoints that you don't
76
+ # intend to test.
77
+ # @!attribute [rw] protocol
78
+ # @return [::String]
79
+ # IP Protocol of the test. When not provided, "TCP" is assumed.
80
+ # @!attribute [rw] related_projects
81
+ # @return [::Array<::String>]
82
+ # Other projects that may be relevant for reachability analysis.
83
+ # This is applicable to scenarios where a test can cross project boundaries.
84
+ # @!attribute [r] display_name
85
+ # @return [::String]
86
+ # Output only. The display name of a Connectivity Test.
87
+ # @!attribute [rw] labels
88
+ # @return [::Google::Protobuf::Map{::String => ::String}]
89
+ # Resource labels to represent user-provided metadata.
90
+ # @!attribute [r] create_time
91
+ # @return [::Google::Protobuf::Timestamp]
92
+ # Output only. The time the test was created.
93
+ # @!attribute [r] update_time
94
+ # @return [::Google::Protobuf::Timestamp]
95
+ # Output only. The time the test's configuration was updated.
96
+ # @!attribute [r] reachability_details
97
+ # @return [::Google::Cloud::NetworkManagement::V1::ReachabilityDetails]
98
+ # Output only. The reachability details of this test from the latest run.
99
+ # The details are updated when creating a new test, updating an
100
+ # existing test, or triggering a one-time rerun of an existing test.
101
+ class ConnectivityTest
102
+ include ::Google::Protobuf::MessageExts
103
+ extend ::Google::Protobuf::MessageExts::ClassMethods
104
+
105
+ # @!attribute [rw] key
106
+ # @return [::String]
107
+ # @!attribute [rw] value
108
+ # @return [::String]
109
+ class LabelsEntry
110
+ include ::Google::Protobuf::MessageExts
111
+ extend ::Google::Protobuf::MessageExts::ClassMethods
112
+ end
113
+ end
114
+
115
+ # Source or destination of the Connectivity Test.
116
+ # @!attribute [rw] ip_address
117
+ # @return [::String]
118
+ # The IP address of the endpoint, which can be an external or internal IP.
119
+ # An IPv6 address is only allowed when the test's destination is a
120
+ # [global load balancer VIP](/load-balancing/docs/load-balancing-overview).
121
+ # @!attribute [rw] port
122
+ # @return [::Integer]
123
+ # The IP protocol port of the endpoint.
124
+ # Only applicable when protocol is TCP or UDP.
125
+ # @!attribute [rw] instance
126
+ # @return [::String]
127
+ # A Compute Engine instance URI.
128
+ # @!attribute [rw] gke_master_cluster
129
+ # @return [::String]
130
+ # A cluster URI for [Google Kubernetes Engine
131
+ # master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture).
132
+ # @!attribute [rw] cloud_sql_instance
133
+ # @return [::String]
134
+ # A [Cloud SQL](https://cloud.google.com/sql) instance URI.
135
+ # @!attribute [rw] network
136
+ # @return [::String]
137
+ # A Compute Engine network URI.
138
+ # @!attribute [rw] network_type
139
+ # @return [::Google::Cloud::NetworkManagement::V1::Endpoint::NetworkType]
140
+ # Type of the network where the endpoint is located.
141
+ # Applicable only to source endpoint, as destination network type can be
142
+ # inferred from the source.
143
+ # @!attribute [rw] project_id
144
+ # @return [::String]
145
+ # Project ID where the endpoint is located.
146
+ # The Project ID can be derived from the URI if you provide a VM instance or
147
+ # network URI.
148
+ # The following are two cases where you must provide the project ID:
149
+ # 1. Only the IP address is specified, and the IP address is within a GCP
150
+ # project.
151
+ # 2. When you are using Shared VPC and the IP address that you provide is
152
+ # from the service project. In this case, the network that the IP address
153
+ # resides in is defined in the host project.
154
+ class Endpoint
155
+ include ::Google::Protobuf::MessageExts
156
+ extend ::Google::Protobuf::MessageExts::ClassMethods
157
+
158
+ # The type definition of an endpoint's network. Use one of the
159
+ # following choices:
160
+ module NetworkType
161
+ # Default type if unspecified.
162
+ NETWORK_TYPE_UNSPECIFIED = 0
163
+
164
+ # A network hosted within Google Cloud Platform.
165
+ # To receive more detailed output, specify the URI for the source or
166
+ # destination network.
167
+ GCP_NETWORK = 1
168
+
169
+ # A network hosted outside of Google Cloud Platform.
170
+ # This can be an on-premises network, or a network hosted by another cloud
171
+ # provider.
172
+ NON_GCP_NETWORK = 2
173
+ end
174
+ end
175
+
176
+ # Results of the configuration analysis from the last run of the test.
177
+ # @!attribute [rw] result
178
+ # @return [::Google::Cloud::NetworkManagement::V1::ReachabilityDetails::Result]
179
+ # The overall result of the test's configuration analysis.
180
+ # @!attribute [rw] verify_time
181
+ # @return [::Google::Protobuf::Timestamp]
182
+ # The time of the configuration analysis.
183
+ # @!attribute [rw] error
184
+ # @return [::Google::Rpc::Status]
185
+ # The details of a failure or a cancellation of reachability analysis.
186
+ # @!attribute [rw] traces
187
+ # @return [::Array<::Google::Cloud::NetworkManagement::V1::Trace>]
188
+ # Result may contain a list of traces if a test has multiple possible
189
+ # paths in the network, such as when destination endpoint is a load balancer
190
+ # with multiple backends.
191
+ class ReachabilityDetails
192
+ include ::Google::Protobuf::MessageExts
193
+ extend ::Google::Protobuf::MessageExts::ClassMethods
194
+
195
+ # The overall result of the test's configuration analysis.
196
+ module Result
197
+ # No result was specified.
198
+ RESULT_UNSPECIFIED = 0
199
+
200
+ # Possible scenarios are:
201
+ #
202
+ # * The configuration analysis determined that a packet originating from
203
+ # the source is expected to reach the destination.
204
+ # * The analysis didn't complete because the user lacks permission for
205
+ # some of the resources in the trace. However, at the time the user's
206
+ # permission became insufficient, the trace had been successful so far.
207
+ REACHABLE = 1
208
+
209
+ # A packet originating from the source is expected to be dropped before
210
+ # reaching the destination.
211
+ UNREACHABLE = 2
212
+
213
+ # The source and destination endpoints do not uniquely identify
214
+ # the test location in the network, and the reachability result contains
215
+ # multiple traces. For some traces, a packet could be delivered, and for
216
+ # others, it would not be.
217
+ AMBIGUOUS = 4
218
+
219
+ # The configuration analysis did not complete. Possible reasons are:
220
+ #
221
+ # * A permissions error occurred--for example, the user might not have
222
+ # read permission for all of the resources named in the test.
223
+ # * An internal error occurred.
224
+ # * The analyzer received an invalid or unsupported argument or was unable
225
+ # to identify a known endpoint.
226
+ UNDETERMINED = 5
227
+ end
228
+ end
229
+ end
230
+ end
231
+ end
232
+ end