google-cloud-run-v2 0.1.0

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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/cloud/run/v2/condition.rb

@@ -0,0 +1,260 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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 Run
+      module V2
+        # Defines a status condition for a resource.
+        # @!attribute [rw] type
+        #   @return [::String]
+        #     type is used to communicate the status of the reconciliation process.
+        #     See also:
+        #     https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting
+        #     Types common to all resources include:
+        #     * "Ready": True when the Resource is ready.
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::Run::V2::Condition::State]
+        #     State of the condition.
+        # @!attribute [rw] message
+        #   @return [::String]
+        #     Human readable message indicating details about the current status.
+        # @!attribute [rw] last_transition_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Last time the condition transitioned from one status to another.
+        # @!attribute [rw] severity
+        #   @return [::Google::Cloud::Run::V2::Condition::Severity]
+        #     How to interpret failures of this condition, one of Error, Warning, Info
+        # @!attribute [rw] reason
+        #   @return [::Google::Cloud::Run::V2::Condition::CommonReason]
+        #     A common (service-level) reason for this condition.
+        # @!attribute [rw] internal_reason
+        #   @return [::Google::Cloud::Run::V2::Condition::InternalReason]
+        #     A reason for the internal condition.
+        # @!attribute [rw] domain_mapping_reason
+        #   @return [::Google::Cloud::Run::V2::Condition::DomainMappingReason]
+        #     A reason for the domain mapping condition.
+        # @!attribute [rw] revision_reason
+        #   @return [::Google::Cloud::Run::V2::Condition::RevisionReason]
+        #     A reason for the revision condition.
+        # @!attribute [rw] execution_reason
+        #   @return [::Google::Cloud::Run::V2::Condition::ExecutionReason]
+        #     A reason for the execution condition.
+        class Condition
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Represents the possible Condition states.
+          module State
+            # The default value. This value is used if the state is omitted.
+            STATE_UNSPECIFIED = 0
+
+            # Transient state: Reconciliation has not started yet.
+            CONDITION_PENDING = 1
+
+            # Transient state: reconciliation is still in progress.
+            CONDITION_RECONCILING = 2
+
+            # Terminal state: Reconciliation did not succeed.
+            CONDITION_FAILED = 3
+
+            # Terminal state: Reconciliation completed successfully.
+            CONDITION_SUCCEEDED = 4
+          end
+
+          # Represents the severity of the condition failures.
+          module Severity
+            # Unspecified severity
+            SEVERITY_UNSPECIFIED = 0
+
+            # Error severity.
+            ERROR = 1
+
+            # Warning severity.
+            WARNING = 2
+
+            # Info severity.
+            INFO = 3
+          end
+
+          # Reasons common to all types of conditions.
+          module CommonReason
+            # Default value.
+            COMMON_REASON_UNDEFINED = 0
+
+            # Reason unknown. Further details will be in message.
+            UNKNOWN = 1
+
+            # The internal route is missing.
+            ROUTE_MISSING = 2
+
+            # Revision creation process failed.
+            REVISION_FAILED = 3
+
+            # Timed out waiting for completion.
+            PROGRESS_DEADLINE_EXCEEDED = 4
+
+            # There was a build error.
+            BUILD_STEP_FAILED = 5
+
+            # The container image path is incorrect.
+            CONTAINER_MISSING = 6
+
+            # Insufficient permissions on the container image.
+            CONTAINER_PERMISSION_DENIED = 7
+
+            # Container image is not authorized by policy.
+            CONTAINER_IMAGE_UNAUTHORIZED = 8
+
+            # Container image policy authorization check failed.
+            CONTAINER_IMAGE_AUTHORIZATION_CHECK_FAILED = 9
+
+            # Insufficient permissions on encryption key.
+            ENCRYPTION_KEY_PERMISSION_DENIED = 10
+
+            # Permission check on encryption key failed.
+            ENCRYPTION_KEY_CHECK_FAILED = 11
+
+            # At least one Access check on secrets failed.
+            SECRETS_ACCESS_CHECK_FAILED = 12
+
+            # Waiting for operation to complete.
+            WAITING_FOR_OPERATION = 13
+
+            # System will retry immediately.
+            IMMEDIATE_RETRY = 14
+
+            # System will retry later; current attempt failed.
+            POSTPONED_RETRY = 15
+          end
+
+          # Reasons applicable to internal resources not exposed to users. These will
+          # surface in Service.conditions, and could be useful for further diagnosis.
+          module InternalReason
+            # Default value.
+            INTERNAL_REASON_UNDEFINED = 0
+
+            # The revision name provided conflicts with an existing one.
+            CONFLICTING_REVISION_NAME = 1
+
+            # Revision is missing; this is usually a transient reason.
+            REVISION_MISSING = 2
+
+            # Internal configuration is missing; this is usually a transient reason.
+            CONFIGURATION_MISSING = 3
+
+            # Assigning traffic; this is a transient reason.
+            ASSIGNING_TRAFFIC = 4
+
+            # Updating ingress traffic settings; this is a transient reason.
+            UPDATING_INGRESS_TRAFFIC_ALLOWED = 5
+
+            # The revision can't be created because it violates an org policy setting.
+            REVISION_ORG_POLICY_VIOLATION = 6
+
+            # Enabling GCFv2 URI support; this is a transient reason.
+            ENABLING_GCFV2_URI_SUPPORT = 7
+          end
+
+          # Reasons specific to DomainMapping resource.
+          module DomainMappingReason
+            # Default value.
+            DOMAIN_MAPPING_REASON_UNDEFINED = 0
+
+            # Internal route is not yet ready.
+            ROUTE_NOT_READY = 1
+
+            # Insufficient permissions.
+            PERMISSION_DENIED = 2
+
+            # Certificate already exists.
+            CERTIFICATE_ALREADY_EXISTS = 3
+
+            # Mapping already exists.
+            MAPPING_ALREADY_EXISTS = 4
+
+            # Certificate issuance pending.
+            CERTIFICATE_PENDING = 5
+
+            # Certificate issuance failed.
+            CERTIFICATE_FAILED = 6
+          end
+
+          # Reasons specific to Revision resource.
+          module RevisionReason
+            # Default value.
+            REVISION_REASON_UNDEFINED = 0
+
+            # Revision in Pending state.
+            PENDING = 1
+
+            # Revision is in Reserve state.
+            RESERVE = 2
+
+            # Revision is Retired.
+            RETIRED = 3
+
+            # Revision is being retired.
+            RETIRING = 4
+
+            # Revision is being recreated.
+            RECREATING = 5
+
+            # There was a health check error.
+            HEALTH_CHECK_CONTAINER_ERROR = 6
+
+            # Health check failed due to user error from customized path of the
+            # container. System will retry.
+            CUSTOMIZED_PATH_RESPONSE_PENDING = 7
+
+            # A revision with min_instance_count > 0 was created and is reserved, but
+            # it was not configured to serve traffic, so it's not live. This can also
+            # happen momentarily during traffic migration.
+            MIN_INSTANCES_NOT_PROVISIONED = 8
+
+            # The maximum allowed number of active revisions has been reached.
+            ACTIVE_REVISION_LIMIT_REACHED = 9
+
+            # There was no deployment defined.
+            # This value is no longer used, but Services created in older versions of
+            # the API might contain this value.
+            NO_DEPLOYMENT = 10
+
+            # A revision's container has no port specified since the revision is of a
+            # manually scaled service with 0 instance count
+            HEALTH_CHECK_SKIPPED = 11
+          end
+
+          # Reasons specific to Execution resource.
+          module ExecutionReason
+            # Default value.
+            EXECUTION_REASON_UNDEFINED = 0
+
+            # Internal system error getting execution status. System will retry.
+            JOB_STATUS_SERVICE_POLLING_ERROR = 1
+
+            # A task reached its retry limit and the last attempt failed due to the
+            # user container exiting with a non-zero exit code.
+            NON_ZERO_EXIT_CODE = 2
+          end
+        end
+      end
+    end
+  end
+end