google-maps-fleet_engine-delivery-v1 0.a → 0.2.0

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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"
+    #         pattern: "projects/{project}/topics/{topic}"
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       pattern: "projects/{project}/topics/{topic}"
+    #
+    # 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"
+    #         pattern: "projects/{project}/logs/{log}"
+    #         pattern: "folders/{folder}/logs/{log}"
+    #         pattern: "organizations/{organization}/logs/{log}"
+    #         pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'logging.googleapis.com/LogEntry'
+    #       pattern: "projects/{project}/logs/{log}"
+    #       pattern: "folders/{folder}/logs/{log}"
+    #       pattern: "organizations/{organization}/logs/{log}"
+    #       pattern: "billingAccounts/{billing_account}/logs/{log}"
+    # @!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/api/routing.rb

@@ -0,0 +1,459 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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
+    # Specifies the routing information that should be sent along with the request
+    # in the form of routing header.
+    # **NOTE:** All service configuration rules follow the "last one wins" order.
+    #
+    # The examples below will apply to an RPC which has the following request type:
+    #
+    # Message Definition:
+    #
+    #     message Request {
+    #       // The name of the Table
+    #       // Values can be of the following formats:
+    #       // - `projects/<project>/tables/<table>`
+    #       // - `projects/<project>/instances/<instance>/tables/<table>`
+    #       // - `region/<region>/zones/<zone>/tables/<table>`
+    #       string table_name = 1;
+    #
+    #       // This value specifies routing for replication.
+    #       // It can be in the following formats:
+    #       // - `profiles/<profile_id>`
+    #       // - a legacy `profile_id` that can be any string
+    #       string app_profile_id = 2;
+    #     }
+    #
+    # Example message:
+    #
+    #     {
+    #       table_name: projects/proj_foo/instances/instance_bar/table/table_baz,
+    #       app_profile_id: profiles/prof_qux
+    #     }
+    #
+    # The routing header consists of one or multiple key-value pairs. Every key
+    # and value must be percent-encoded, and joined together in the format of
+    # `key1=value1&key2=value2`.
+    # In the examples below I am skipping the percent-encoding for readablity.
+    #
+    # Example 1
+    #
+    # Extracting a field from the request to put into the routing header
+    # unchanged, with the key equal to the field name.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `app_profile_id`.
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params: app_profile_id=profiles/prof_qux
+    #
+    # Example 2
+    #
+    # Extracting a field from the request to put into the routing header
+    # unchanged, with the key different from the field name.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `app_profile_id`, but name it `routing_id` in the header.
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "{routing_id=**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params: routing_id=profiles/prof_qux
+    #
+    # Example 3
+    #
+    # Extracting a field from the request to put into the routing
+    # header, while matching a path template syntax on the field's value.
+    #
+    # NB: it is more useful to send nothing than to send garbage for the purpose
+    # of dynamic routing, since garbage pollutes cache. Thus the matching.
+    #
+    # Sub-example 3a
+    #
+    # The field matches the template.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `table_name`, if it's well-formed (with project-based
+    #       // syntax).
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_name=projects/*/instances/*/**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     table_name=projects/proj_foo/instances/instance_bar/table/table_baz
+    #
+    # Sub-example 3b
+    #
+    # The field does not match the template.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `table_name`, if it's well-formed (with region-based
+    #       // syntax).
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_name=regions/*/zones/*/**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     <no routing header will be sent>
+    #
+    # Sub-example 3c
+    #
+    # Multiple alternative conflictingly named path templates are
+    # specified. The one that matches is used to construct the header.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take the `table_name`, if it's well-formed, whether
+    #       // using the region- or projects-based syntax.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_name=regions/*/zones/*/**}"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_name=projects/*/instances/*/**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     table_name=projects/proj_foo/instances/instance_bar/table/table_baz
+    #
+    # Example 4
+    #
+    # Extracting a single routing header key-value pair by matching a
+    # template syntax on (a part of) a single request field.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // Take just the project id from the `table_name` field.
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*}/**"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params: routing_id=projects/proj_foo
+    #
+    # Example 5
+    #
+    # Extracting a single routing header key-value pair by matching
+    # several conflictingly named path templates on (parts of) a single request
+    # field. The last template to match "wins" the conflict.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // If the `table_name` does not have instances information,
+    #       // take just the project id for routing.
+    #       // Otherwise take project + instance.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*/instances/*}/**"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     routing_id=projects/proj_foo/instances/instance_bar
+    #
+    # Example 6
+    #
+    # Extracting multiple routing header key-value pairs by matching
+    # several non-conflicting path templates on (parts of) a single request field.
+    #
+    # Sub-example 6a
+    #
+    # Make the templates strict, so that if the `table_name` does not
+    # have an instance information, nothing is sent.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // The routing code needs two keys instead of one composite
+    #       // but works only for the tables with the "project-instance" name
+    #       // syntax.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{project_id=projects/*}/instances/*/**"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "projects/*/{instance_id=instances/*}/**"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     project_id=projects/proj_foo&instance_id=instances/instance_bar
+    #
+    # Sub-example 6b
+    #
+    # Make the templates loose, so that if the `table_name` does not
+    # have an instance information, just the project id part is sent.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // The routing code wants two keys instead of one composite
+    #       // but will work with just the `project_id` for tables without
+    #       // an instance in the `table_name`.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{project_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "projects/*/{instance_id=instances/*}/**"
+    #       }
+    #     };
+    #
+    # result (is the same as 6a for our example message because it has the instance
+    # information):
+    #
+    #     x-goog-request-params:
+    #     project_id=projects/proj_foo&instance_id=instances/instance_bar
+    #
+    # Example 7
+    #
+    # Extracting multiple routing header key-value pairs by matching
+    # several path templates on multiple request fields.
+    #
+    # NB: note that here there is no way to specify sending nothing if one of the
+    # fields does not match its template. E.g. if the `table_name` is in the wrong
+    # format, the `project_id` will not be sent, but the `routing_id` will be.
+    # The backend routing code has to be aware of that and be prepared to not
+    # receive a full complement of keys if it expects multiple.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // The routing needs both `project_id` and `routing_id`
+    #       // (from the `app_profile_id` field) for routing.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{project_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "{routing_id=**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     project_id=projects/proj_foo&routing_id=profiles/prof_qux
+    #
+    # Example 8
+    #
+    # Extracting a single routing header key-value pair by matching
+    # several conflictingly named path templates on several request fields. The
+    # last template to match "wins" the conflict.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // The `routing_id` can be a project id or a region id depending on
+    #       // the table name format, but only if the `app_profile_id` is not set.
+    #       // If `app_profile_id` is set it should be used instead.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #          field: "table_name"
+    #          path_template: "{routing_id=regions/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "{routing_id=**}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params: routing_id=profiles/prof_qux
+    #
+    # Example 9
+    #
+    # Bringing it all together.
+    #
+    # annotation:
+    #
+    #     option (google.api.routing) = {
+    #       // For routing both `table_location` and a `routing_id` are needed.
+    #       //
+    #       // table_location can be either an instance id or a region+zone id.
+    #       //
+    #       // For `routing_id`, take the value of `app_profile_id`
+    #       // - If it's in the format `profiles/<profile_id>`, send
+    #       // just the `<profile_id>` part.
+    #       // - If it's any other literal, send it as is.
+    #       // If the `app_profile_id` is empty, and the `table_name` starts with
+    #       // the project_id, send that instead.
+    #
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "projects/*/{table_location=instances/*}/tables/*"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{table_location=regions/*/zones/*}/tables/*"
+    #       }
+    #       routing_parameters {
+    #         field: "table_name"
+    #         path_template: "{routing_id=projects/*}/**"
+    #       }
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "{routing_id=**}"
+    #       }
+    #       routing_parameters {
+    #         field: "app_profile_id"
+    #         path_template: "profiles/{routing_id=*}"
+    #       }
+    #     };
+    #
+    # result:
+    #
+    #     x-goog-request-params:
+    #     table_location=instances/instance_bar&routing_id=prof_qux
+    # @!attribute [rw] routing_parameters
+    #   @return [::Array<::Google::Api::RoutingParameter>]
+    #     A collection of Routing Parameter specifications.
+    #     **NOTE:** If multiple Routing Parameters describe the same key
+    #     (via the `path_template` field or via the `field` field when
+    #     `path_template` is not provided), "last one wins" rule
+    #     determines which Parameter gets used.
+    #     See the examples for more details.
+    class RoutingRule
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # A projection from an input message to the GRPC or REST header.
+    # @!attribute [rw] field
+    #   @return [::String]
+    #     A request field to extract the header key-value pair from.
+    # @!attribute [rw] path_template
+    #   @return [::String]
+    #     A pattern matching the key-value field. Optional.
+    #     If not specified, the whole field specified in the `field` field will be
+    #     taken as value, and its name used as key. If specified, it MUST contain
+    #     exactly one named segment (along with any number of unnamed segments) The
+    #     pattern will be matched over the field specified in the `field` field, then
+    #     if the match is successful:
+    #     - the name of the single named segment will be used as a header name,
+    #     - the match value of the segment will be used as a header value;
+    #     if the match is NOT successful, nothing will be sent.
+    #
+    #     Example:
+    #
+    #                   -- This is a field in the request message
+    #                  |   that the header value will be extracted from.
+    #                  |
+    #                  |                     -- This is the key name in the
+    #                  |                    |   routing header.
+    #                  V                    |
+    #         field: "table_name"           v
+    #         path_template: "projects/*/{table_location=instances/*}/tables/*"
+    #                                                    ^            ^
+    #                                                    |            |
+    #           In the {} brackets is the pattern that --             |
+    #           specifies what to extract from the                    |
+    #           field as a value to be sent.                          |
+    #                                                                 |
+    #          The string in the field must match the whole pattern --
+    #          before brackets, inside brackets, after brackets.
+    #
+    #     When looking at this specific example, we can see that:
+    #     - A key-value pair with the key `table_location`
+    #       and the value matching `instances/*` should be added
+    #       to the x-goog-request-params routing header.
+    #     - The value is extracted from the request message's `table_name` field
+    #       if it matches the full pattern specified:
+    #       `projects/*/instances/*/tables/*`.
+    #
+    #     **NB:** If the `path_template` field is not provided, the key name is
+    #     equal to the field name, and the whole field should be sent as a value.
+    #     This makes the pattern for the field and the value functionally equivalent
+    #     to `**`, and the configuration
+    #
+    #         {
+    #           field: "table_name"
+    #         }
+    #
+    #     is a functionally equivalent shorthand to:
+    #
+    #         {
+    #           field: "table_name"
+    #           path_template: "{table_name=**}"
+    #         }
+    #
+    #     See Example 1 for more details.
+    class RoutingParameter
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end