google-cloud-network_management-v1 0.1.0

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Network Management V1 Protocol Buffer Documentation
+
+These files are for the YARD documentation of the generated protobuf files.
+They are not intended to be required or loaded at runtime.

data/proto_docs/google/api/field_behavior.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Api
+    # An indicator of the behavior of a given field (for example, that a field
+    # is required in requests, or given as output but ignored as input).
+    # This **does not** change the behavior in protocol buffers itself; it only
+    # denotes the behavior and may affect how API tooling handles the field.
+    #
+    # Note: This enum **may** receive new values in the future.
+    module FieldBehavior
+      # Conventional default for enums. Do not use this.
+      FIELD_BEHAVIOR_UNSPECIFIED = 0
+
+      # Specifically denotes a field as optional.
+      # While all fields in protocol buffers are optional, this may be specified
+      # for emphasis if appropriate.
+      OPTIONAL = 1
+
+      # Denotes a field as required.
+      # This indicates that the field **must** be provided as part of the request,
+      # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
+      REQUIRED = 2
+
+      # Denotes a field as output only.
+      # This indicates that the field is provided in responses, but including the
+      # field in a request does nothing (the server *must* ignore it and
+      # *must not* throw an error as a result of the field's presence).
+      OUTPUT_ONLY = 3
+
+      # Denotes a field as input only.
+      # This indicates that the field is provided in requests, and the
+      # corresponding field is not included in output.
+      INPUT_ONLY = 4
+
+      # Denotes a field as immutable.
+      # This indicates that the field may be set once in a request to create a
+      # resource, but may not be changed thereafter.
+      IMMUTABLE = 5
+
+      # Denotes that a (repeated) field is an unordered list.
+      # This indicates that the service may provide the elements of the list
+      # in any arbitrary  order, rather than the order the user originally
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
+    end
+  end
+end

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,283 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Api
+    # A simple descriptor of a resource type.
+    #
+    # ResourceDescriptor annotates a resource message (either by means of a
+    # protobuf annotation or use in the service config), and associates the
+    # resource's schema, the resource type, and the pattern of the resource name.
+    #
+    # Example:
+    #
+    #     message Topic {
+    #       // Indicates this message defines a resource schema.
+    #       // Declares the resource type in the format of {service}/{kind}.
+    #       // For Kubernetes resources, the format is {api group}/{kind}.
+    #       option (google.api.resource) = {
+    #         type: "pubsub.googleapis.com/Topic"
+    #         name_descriptor: {
+    #           pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #
+    # Sometimes, resources have multiple patterns, typically because they can
+    # live under multiple parents.
+    #
+    # Example:
+    #
+    #     message LogEntry {
+    #       option (google.api.resource) = {
+    #         type: "logging.googleapis.com/LogEntry"
+    #         name_descriptor: {
+    #           pattern: "projects/{project}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "folders/{folder}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #           parent_name_extractor: "folders/{folder}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "organizations/{organization}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
+    #           parent_name_extractor: "organizations/{organization}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #           parent_type: "billing.googleapis.com/BillingAccount"
+    #           parent_name_extractor: "billingAccounts/{billing_account}"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'logging.googleapis.com/LogEntry'
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         - pattern: "folders/{folder}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #           parent_name_extractor: "folders/{folder}"
+    #         - pattern: "organizations/{organization}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
+    #           parent_name_extractor: "organizations/{organization}"
+    #         - pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #           parent_type: "billing.googleapis.com/BillingAccount"
+    #           parent_name_extractor: "billingAccounts/{billing_account}"
+    #
+    # For flexible resources, the resource name doesn't contain parent names, but
+    # the resource itself has parents for policy evaluation.
+    #
+    # Example:
+    #
+    #     message Shelf {
+    #       option (google.api.resource) = {
+    #         type: "library.googleapis.com/Shelf"
+    #         name_descriptor: {
+    #           pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'library.googleapis.com/Shelf'
+    #       name_descriptor:
+    #         - pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #         - pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type. It must be in the format of
+    #     \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
+    #     singular and must not include version numbers.
+    #
+    #     Example: `storage.googleapis.com/Bucket`
+    #
+    #     The value of the resource_type_kind must follow the regular expression
+    #     /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
+    #     should use PascalCase (UpperCamelCase). The maximum number of
+    #     characters allowed for the `resource_type_kind` is 100.
+    # @!attribute [rw] pattern
+    #   @return [::Array<::String>]
+    #     Optional. The relative resource name pattern associated with this resource
+    #     type. The DNS prefix of the full resource name shouldn't be specified here.
+    #
+    #     The path pattern must follow the syntax, which aligns with HTTP binding
+    #     syntax:
+    #
+    #         Template = Segment { "/" Segment } ;
+    #         Segment = LITERAL | Variable ;
+    #         Variable = "{" LITERAL "}" ;
+    #
+    #     Examples:
+    #
+    #         - "projects/\\{project}/topics/\\{topic}"
+    #         - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
+    #
+    #     The components in braces correspond to the IDs for each resource in the
+    #     hierarchy. It is expected that, if multiple patterns are provided,
+    #     the same component name (e.g. "project") refers to IDs of the same
+    #     type of resource.
+    # @!attribute [rw] name_field
+    #   @return [::String]
+    #     Optional. The field on the resource that designates the resource name
+    #     field. If omitted, this is assumed to be "name".
+    # @!attribute [rw] history
+    #   @return [::Google::Api::ResourceDescriptor::History]
+    #     Optional. The historical or future-looking state of the resource pattern.
+    #
+    #     Example:
+    #
+    #         // The InspectTemplate message originally only supported resource
+    #         // names with organization, and project was added later.
+    #         message InspectTemplate {
+    #           option (google.api.resource) = {
+    #             type: "dlp.googleapis.com/InspectTemplate"
+    #             pattern:
+    #             "organizations/{organization}/inspectTemplates/{inspect_template}"
+    #             pattern: "projects/{project}/inspectTemplates/{inspect_template}"
+    #             history: ORIGINALLY_SINGLE_PATTERN
+    #           };
+    #         }
+    # @!attribute [rw] plural
+    #   @return [::String]
+    #     The plural name used in the resource name and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
+    #     concept of the `plural` field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
+    # @!attribute [rw] singular
+    #   @return [::String]
+    #     The same concept of the `singular` field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
+    class ResourceDescriptor
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # A description of the historical or future-looking state of the
+      # resource pattern.
+      module History
+        # The "unset" value.
+        HISTORY_UNSPECIFIED = 0
+
+        # The resource originally had one pattern and launched as such, and
+        # additional patterns were added later.
+        ORIGINALLY_SINGLE_PATTERN = 1
+
+        # The resource has one pattern, but the API owner expects to add more
+        # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
+        # that from being necessary once there are multiple patterns.)
+        FUTURE_MULTI_PATTERN = 2
+      end
+
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      end
+    end
+
+    # Defines a proto annotation that describes a string field that refers to
+    # an API resource.
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type that the annotated field references.
+    #
+    #     Example:
+    #
+    #         message Subscription {
+    #           string topic = 2 [(google.api.resource_reference) = {
+    #             type: "pubsub.googleapis.com/Topic"
+    #           }];
+    #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
+    # @!attribute [rw] child_type
+    #   @return [::String]
+    #     The resource type of a child collection that the annotated field
+    #     references. This is useful for annotating the `parent` field that
+    #     doesn't have a fixed resource type.
+    #
+    #     Example:
+    #
+    #         message ListLogEntriesRequest {
+    #           string parent = 1 [(google.api.resource_reference) = {
+    #             child_type: "logging.googleapis.com/LogEntry"
+    #           };
+    #         }
+    class ResourceReference
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/cloud/networkmanagement/v1/connectivity_test.rb

@@ -0,0 +1,232 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module NetworkManagement
+      module V1
+        # A Connectivity Test for a network reachability analysis.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Unique name of the resource using the form:
+        #         `projects/{project_id}/locations/global/connectivityTests/{test_id}`
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     The user-supplied description of the Connectivity Test.
+        #     Maximum of 512 characters.
+        # @!attribute [rw] source
+        #   @return [::Google::Cloud::NetworkManagement::V1::Endpoint]
+        #     Required. Source specification of the Connectivity Test.
+        #
+        #     You can use a combination of source IP address, virtual machine
+        #     (VM) instance, or Compute Engine network to uniquely identify
+        #     the source location.
+        #
+        #     Examples:
+        #     If the source IP address is an internal IP address within a Google Cloud
+        #     Virtual Private Cloud (VPC) network, then you must also specify the VPC
+        #     network. Otherwise, specify the VM instance, which already contains its
+        #     internal IP address and VPC network information.
+        #
+        #     If the source of the test is within an on-premises network, then you must
+        #     provide the destination VPC network.
+        #
+        #     If the source endpoint is a Compute Engine VM instance with multiple
+        #     network interfaces, the instance itself is not sufficient to identify the
+        #     endpoint. So, you must also specify the source IP address or VPC network.
+        #
+        #     A reachability analysis proceeds even if the source location is
+        #     ambiguous. However, the test result may include endpoints that you don't
+        #     intend to test.
+        # @!attribute [rw] destination
+        #   @return [::Google::Cloud::NetworkManagement::V1::Endpoint]
+        #     Required. Destination specification of the Connectivity Test.
+        #
+        #     You can use a combination of destination IP address, Compute Engine
+        #     VM instance, or VPC network to uniquely identify the destination
+        #     location.
+        #
+        #     Even if the destination IP address is not unique, the source IP
+        #     location is unique. Usually, the analysis can infer the destination
+        #     endpoint from route information.
+        #
+        #     If the destination you specify is a VM instance and the instance has
+        #     multiple network interfaces, then you must also specify either
+        #     a destination IP address  or VPC network to identify the destination
+        #     interface.
+        #
+        #     A reachability analysis proceeds even if the destination location is
+        #     ambiguous. However, the result can include endpoints that you don't
+        #     intend to test.
+        # @!attribute [rw] protocol
+        #   @return [::String]
+        #     IP Protocol of the test. When not provided, "TCP" is assumed.
+        # @!attribute [rw] related_projects
+        #   @return [::Array<::String>]
+        #     Other projects that may be relevant for reachability analysis.
+        #     This is applicable to scenarios where a test can cross project boundaries.
+        # @!attribute [r] display_name
+        #   @return [::String]
+        #     Output only. The display name of a Connectivity Test.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Resource labels to represent user-provided metadata.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the test was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the test's configuration was updated.
+        # @!attribute [r] reachability_details
+        #   @return [::Google::Cloud::NetworkManagement::V1::ReachabilityDetails]
+        #     Output only. The reachability details of this test from the latest run.
+        #     The details are updated when creating a new test, updating an
+        #     existing test, or triggering a one-time rerun of an existing test.
+        class ConnectivityTest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Source or destination of the Connectivity Test.
+        # @!attribute [rw] ip_address
+        #   @return [::String]
+        #     The IP address of the endpoint, which can be an external or internal IP.
+        #     An IPv6 address is only allowed when the test's destination is a
+        #     [global load balancer VIP](/load-balancing/docs/load-balancing-overview).
+        # @!attribute [rw] port
+        #   @return [::Integer]
+        #     The IP protocol port of the endpoint.
+        #     Only applicable when protocol is TCP or UDP.
+        # @!attribute [rw] instance
+        #   @return [::String]
+        #     A Compute Engine instance URI.
+        # @!attribute [rw] gke_master_cluster
+        #   @return [::String]
+        #     A cluster URI for [Google Kubernetes Engine
+        #     master](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture).
+        # @!attribute [rw] cloud_sql_instance
+        #   @return [::String]
+        #     A [Cloud SQL](https://cloud.google.com/sql) instance URI.
+        # @!attribute [rw] network
+        #   @return [::String]
+        #     A Compute Engine network URI.
+        # @!attribute [rw] network_type
+        #   @return [::Google::Cloud::NetworkManagement::V1::Endpoint::NetworkType]
+        #     Type of the network where the endpoint is located.
+        #     Applicable only to source endpoint, as destination network type can be
+        #     inferred from the source.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     Project ID where the endpoint is located.
+        #     The Project ID can be derived from the URI if you provide a VM instance or
+        #     network URI.
+        #     The following are two cases where you must provide the project ID:
+        #     1. Only the IP address is specified, and the IP address is within a GCP
+        #     project.
+        #     2. When you are using Shared VPC and the IP address that you provide is
+        #     from the service project. In this case, the network that the IP address
+        #     resides in is defined in the host project.
+        class Endpoint
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The type definition of an endpoint's network. Use one of the
+          # following choices:
+          module NetworkType
+            # Default type if unspecified.
+            NETWORK_TYPE_UNSPECIFIED = 0
+
+            # A network hosted within Google Cloud Platform.
+            # To receive more detailed output, specify the URI for the source or
+            # destination network.
+            GCP_NETWORK = 1
+
+            # A network hosted outside of Google Cloud Platform.
+            # This can be an on-premises network, or a network hosted by another cloud
+            # provider.
+            NON_GCP_NETWORK = 2
+          end
+        end
+
+        # Results of the configuration analysis from the last run of the test.
+        # @!attribute [rw] result
+        #   @return [::Google::Cloud::NetworkManagement::V1::ReachabilityDetails::Result]
+        #     The overall result of the test's configuration analysis.
+        # @!attribute [rw] verify_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time of the configuration analysis.
+        # @!attribute [rw] error
+        #   @return [::Google::Rpc::Status]
+        #     The details of a failure or a cancellation of reachability analysis.
+        # @!attribute [rw] traces
+        #   @return [::Array<::Google::Cloud::NetworkManagement::V1::Trace>]
+        #     Result may contain a list of traces if a test has multiple possible
+        #     paths in the network, such as when destination endpoint is a load balancer
+        #     with multiple backends.
+        class ReachabilityDetails
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The overall result of the test's configuration analysis.
+          module Result
+            # No result was specified.
+            RESULT_UNSPECIFIED = 0
+
+            # Possible scenarios are:
+            #
+            # * The configuration analysis determined that a packet originating from
+            #   the source is expected to reach the destination.
+            # * The analysis didn't complete because the user lacks permission for
+            #   some of the resources in the trace. However, at the time the user's
+            #   permission became insufficient, the trace had been successful so far.
+            REACHABLE = 1
+
+            # A packet originating from the source is expected to be dropped before
+            # reaching the destination.
+            UNREACHABLE = 2
+
+            # The source and destination endpoints do not uniquely identify
+            # the test location in the network, and the reachability result contains
+            # multiple traces. For some traces, a packet could be delivered, and for
+            # others, it would not be.
+            AMBIGUOUS = 4
+
+            # The configuration analysis did not complete. Possible reasons are:
+            #
+            # * A permissions error occurred--for example, the user might not have
+            #   read permission for all of the resources named in the test.
+            # * An internal error occurred.
+            # * The analyzer received an invalid or unsupported argument or was unable
+            #   to identify a known endpoint.
+            UNDETERMINED = 5
+          end
+        end
+      end
+    end
+  end
+end