google-cloud-app_engine-v1 0.1.0

data/proto_docs/google/appengine/v1/application.rb

@@ -0,0 +1,192 @@
+# 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 AppEngine
+      module V1
+        # An Application resource contains the top-level configuration of an App
+        # Engine application.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Full path to the Application resource in the API.
+        #     Example: `apps/myapp`.
+        # @!attribute [rw] id
+        #   @return [::String]
+        #     Identifier of the Application resource. This identifier is equivalent
+        #     to the project ID of the Google Cloud Platform project where you want to
+        #     deploy your application.
+        #     Example: `myapp`.
+        # @!attribute [rw] dispatch_rules
+        #   @return [::Array<::Google::Cloud::AppEngine::V1::UrlDispatchRule>]
+        #     HTTP path dispatch rules for requests to the application that do not
+        #     explicitly target a service or version. Rules are order-dependent.
+        #     Up to 20 dispatch rules can be supported.
+        # @!attribute [rw] auth_domain
+        #   @return [::String]
+        #     Google Apps authentication domain that controls which users can access
+        #     this application.
+        #
+        #     Defaults to open access for any Google Account.
+        # @!attribute [rw] location_id
+        #   @return [::String]
+        #     Location from which this application runs. Application instances
+        #     run out of the data centers in the specified location, which is also where
+        #     all of the application's end user content is stored.
+        #
+        #     Defaults to `us-central`.
+        #
+        #     View the list of
+        #     [supported locations](https://cloud.google.com/appengine/docs/locations).
+        # @!attribute [rw] code_bucket
+        #   @return [::String]
+        #     Google Cloud Storage bucket that can be used for storing files
+        #     associated with this application. This bucket is associated with the
+        #     application and can be used by the gcloud deployment commands.
+        # @!attribute [rw] default_cookie_expiration
+        #   @return [::Google::Protobuf::Duration]
+        #     Cookie expiration policy for this application.
+        # @!attribute [rw] serving_status
+        #   @return [::Google::Cloud::AppEngine::V1::Application::ServingStatus]
+        #     Serving status of this application.
+        # @!attribute [rw] default_hostname
+        #   @return [::String]
+        #     Hostname used to reach this application, as resolved by App Engine.
+        # @!attribute [rw] default_bucket
+        #   @return [::String]
+        #     Google Cloud Storage bucket that can be used by this application to store
+        #     content.
+        # @!attribute [rw] iap
+        #   @return [::Google::Cloud::AppEngine::V1::Application::IdentityAwareProxy]
+        # @!attribute [rw] gcr_domain
+        #   @return [::String]
+        #     The Google Container Registry domain used for storing managed build docker
+        #     images for this application.
+        # @!attribute [rw] database_type
+        #   @return [::Google::Cloud::AppEngine::V1::Application::DatabaseType]
+        #     The type of the Cloud Firestore or Cloud Datastore database associated with
+        #     this application.
+        # @!attribute [rw] feature_settings
+        #   @return [::Google::Cloud::AppEngine::V1::Application::FeatureSettings]
+        #     The feature specific settings to be used in the application.
+        class Application
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Identity-Aware Proxy
+          # @!attribute [rw] enabled
+          #   @return [::Boolean]
+          #     Whether the serving infrastructure will authenticate and
+          #     authorize all incoming requests.
+          #
+          #     If true, the `oauth2_client_id` and `oauth2_client_secret`
+          #     fields must be non-empty.
+          # @!attribute [rw] oauth2_client_id
+          #   @return [::String]
+          #     OAuth2 client ID to use for the authentication flow.
+          # @!attribute [rw] oauth2_client_secret
+          #   @return [::String]
+          #     OAuth2 client secret to use for the authentication flow.
+          #
+          #     For security reasons, this value cannot be retrieved via the API.
+          #     Instead, the SHA-256 hash of the value is returned in the
+          #     `oauth2_client_secret_sha256` field.
+          # @!attribute [rw] oauth2_client_secret_sha256
+          #   @return [::String]
+          #     Hex-encoded SHA-256 hash of the client secret.
+          class IdentityAwareProxy
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The feature specific settings to be used in the application. These define
+          # behaviors that are user configurable.
+          # @!attribute [rw] split_health_checks
+          #   @return [::Boolean]
+          #     Boolean value indicating if split health checks should be used instead
+          #     of the legacy health checks. At an app.yaml level, this means defaulting
+          #     to 'readiness_check' and 'liveness_check' values instead of
+          #     'health_check' ones. Once the legacy 'health_check' behavior is
+          #     deprecated, and this value is always true, this setting can
+          #     be removed.
+          # @!attribute [rw] use_container_optimized_os
+          #   @return [::Boolean]
+          #     If true, use [Container-Optimized OS](https://cloud.google.com/container-optimized-os/)
+          #     base image for VMs, rather than a base Debian image.
+          class FeatureSettings
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          module ServingStatus
+            # Serving status is unspecified.
+            UNSPECIFIED = 0
+
+            # Application is serving.
+            SERVING = 1
+
+            # Application has been disabled by the user.
+            USER_DISABLED = 2
+
+            # Application has been disabled by the system.
+            SYSTEM_DISABLED = 3
+          end
+
+          module DatabaseType
+            # Database type is unspecified.
+            DATABASE_TYPE_UNSPECIFIED = 0
+
+            # Cloud Datastore
+            CLOUD_DATASTORE = 1
+
+            # Cloud Firestore Native
+            CLOUD_FIRESTORE = 2
+
+            # Cloud Firestore in Datastore Mode
+            CLOUD_DATASTORE_COMPATIBILITY = 3
+          end
+        end
+
+        # Rules to match an HTTP request and dispatch that request to a service.
+        # @!attribute [rw] domain
+        #   @return [::String]
+        #     Domain name to match against. The wildcard "`*`" is supported if
+        #     specified before a period: "`*.`".
+        #
+        #     Defaults to matching all domains: "`*`".
+        # @!attribute [rw] path
+        #   @return [::String]
+        #     Pathname within the host. Must start with a "`/`". A
+        #     single "`*`" can be included at the end of the path.
+        #
+        #     The sum of the lengths of the domain and path may not
+        #     exceed 100 characters.
+        # @!attribute [rw] service
+        #   @return [::String]
+        #     Resource ID of a service in this application that should
+        #     serve the matched request. The service must already
+        #     exist. Example: `default`.
+        class UrlDispatchRule
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/appengine/v1/audit_data.rb

@@ -0,0 +1,56 @@
+# 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 AppEngine
+      module V1
+        # App Engine admin service audit log.
+        # @!attribute [rw] update_service
+        #   @return [::Google::Cloud::AppEngine::V1::UpdateServiceMethod]
+        #     Detailed information about UpdateService call.
+        # @!attribute [rw] create_version
+        #   @return [::Google::Cloud::AppEngine::V1::CreateVersionMethod]
+        #     Detailed information about CreateVersion call.
+        class AuditData
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Detailed information about UpdateService call.
+        # @!attribute [rw] request
+        #   @return [::Google::Cloud::AppEngine::V1::UpdateServiceRequest]
+        #     Update service request.
+        class UpdateServiceMethod
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Detailed information about CreateVersion call.
+        # @!attribute [rw] request
+        #   @return [::Google::Cloud::AppEngine::V1::CreateVersionRequest]
+        #     Create version request.
+        class CreateVersionMethod
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/appengine/v1/certificate.rb

@@ -0,0 +1,161 @@
+# 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 AppEngine
+      module V1
+        # An SSL certificate that a user has been authorized to administer. A user
+        # is authorized to administer any certificate that applies to one of their
+        # authorized domains.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Full path to the `AuthorizedCertificate` resource in the API. Example:
+        #     `apps/myapp/authorizedCertificates/12345`.
+        # @!attribute [rw] id
+        #   @return [::String]
+        #     Relative name of the certificate. This is a unique value autogenerated
+        #     on `AuthorizedCertificate` resource creation. Example: `12345`.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     The user-specified display name of the certificate. This is not
+        #     guaranteed to be unique. Example: `My Certificate`.
+        # @!attribute [rw] domain_names
+        #   @return [::Array<::String>]
+        #     Topmost applicable domains of this certificate. This certificate
+        #     applies to these domains and their subdomains. Example: `example.com`.
+        # @!attribute [rw] expire_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time when this certificate expires. To update the renewal time on this
+        #     certificate, upload an SSL certificate with a different expiration time
+        #     using [`AuthorizedCertificates.UpdateAuthorizedCertificate`]().
+        # @!attribute [rw] certificate_raw_data
+        #   @return [::Google::Cloud::AppEngine::V1::CertificateRawData]
+        #     The SSL certificate serving the `AuthorizedCertificate` resource. This
+        #     must be obtained independently from a certificate authority.
+        # @!attribute [rw] managed_certificate
+        #   @return [::Google::Cloud::AppEngine::V1::ManagedCertificate]
+        #     Only applicable if this certificate is managed by App Engine. Managed
+        #     certificates are tied to the lifecycle of a `DomainMapping` and cannot be
+        #     updated or deleted via the `AuthorizedCertificates` API. If this
+        #     certificate is manually administered by the user, this field will be empty.
+        # @!attribute [rw] visible_domain_mappings
+        #   @return [::Array<::String>]
+        #     The full paths to user visible Domain Mapping resources that have this
+        #     certificate mapped. Example: `apps/myapp/domainMappings/example.com`.
+        #
+        #     This may not represent the full list of mapped domain mappings if the user
+        #     does not have `VIEWER` permissions on all of the applications that have
+        #     this certificate mapped. See `domain_mappings_count` for a complete count.
+        #
+        #     Only returned by `GET` or `LIST` requests when specifically requested by
+        #     the `view=FULL_CERTIFICATE` option.
+        # @!attribute [rw] domain_mappings_count
+        #   @return [::Integer]
+        #     Aggregate count of the domain mappings with this certificate mapped. This
+        #     count includes domain mappings on applications for which the user does not
+        #     have `VIEWER` permissions.
+        #
+        #     Only returned by `GET` or `LIST` requests when specifically requested by
+        #     the `view=FULL_CERTIFICATE` option.
+        class AuthorizedCertificate
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # An SSL certificate obtained from a certificate authority.
+        # @!attribute [rw] public_certificate
+        #   @return [::String]
+        #     PEM encoded x.509 public key certificate. This field is set once on
+        #     certificate creation. Must include the header and footer. Example:
+        #     <pre>
+        #     -----BEGIN CERTIFICATE-----
+        #     <certificate_value>
+        #     -----END CERTIFICATE-----
+        #     </pre>
+        # @!attribute [rw] private_key
+        #   @return [::String]
+        #     Unencrypted PEM encoded RSA private key. This field is set once on
+        #     certificate creation and then encrypted. The key size must be 2048
+        #     bits or fewer. Must include the header and footer. Example:
+        #     <pre>
+        #     -----BEGIN RSA PRIVATE KEY-----
+        #     <unencrypted_key_value>
+        #     -----END RSA PRIVATE KEY-----
+        #     </pre>
+        class CertificateRawData
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A certificate managed by App Engine.
+        # @!attribute [rw] last_renewal_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Time at which the certificate was last renewed. The renewal process is
+        #     fully managed. Certificate renewal will automatically occur before the
+        #     certificate expires. Renewal errors can be tracked via `ManagementStatus`.
+        # @!attribute [rw] status
+        #   @return [::Google::Cloud::AppEngine::V1::ManagementStatus]
+        #     Status of certificate management. Refers to the most recent certificate
+        #     acquisition or renewal attempt.
+        class ManagedCertificate
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # State of certificate management. Refers to the most recent certificate
+        # acquisition or renewal attempt.
+        module ManagementStatus
+          MANAGEMENT_STATUS_UNSPECIFIED = 0
+
+          # Certificate was successfully obtained and inserted into the serving
+          # system.
+          OK = 1
+
+          # Certificate is under active attempts to acquire or renew.
+          PENDING = 2
+
+          # Most recent renewal failed due to an invalid DNS setup and will be
+          # retried. Renewal attempts will continue to fail until the certificate
+          # domain's DNS configuration is fixed. The last successfully provisioned
+          # certificate may still be serving.
+          FAILED_RETRYING_NOT_VISIBLE = 4
+
+          # All renewal attempts have been exhausted, likely due to an invalid DNS
+          # setup.
+          FAILED_PERMANENT = 6
+
+          # Most recent renewal failed due to an explicit CAA record that does not
+          # include one of the in-use CAs (Google CA and Let's Encrypt). Renewals will
+          # continue to fail until the CAA is reconfigured. The last successfully
+          # provisioned certificate may still be serving.
+          FAILED_RETRYING_CAA_FORBIDDEN = 7
+
+          # Most recent renewal failed due to a CAA retrieval failure. This means that
+          # the domain's DNS provider does not properly handle CAA records, failing
+          # requests for CAA records when no CAA records are defined. Renewals will
+          # continue to fail until the DNS provider is changed or a CAA record is
+          # added for the given domain. The last successfully provisioned certificate
+          # may still be serving.
+          FAILED_RETRYING_CAA_CHECKING = 8
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/appengine/v1/deploy.rb

@@ -0,0 +1,130 @@
+# 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 AppEngine
+      module V1
+        # Code and application artifacts used to deploy a version to App Engine.
+        # @!attribute [rw] files
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::AppEngine::V1::FileInfo}]
+        #     Manifest of the files stored in Google Cloud Storage that are included
+        #     as part of this version. All files must be readable using the
+        #     credentials supplied with this call.
+        # @!attribute [rw] container
+        #   @return [::Google::Cloud::AppEngine::V1::ContainerInfo]
+        #     The Docker image for the container that runs the version.
+        #     Only applicable for instances running in the App Engine flexible environment.
+        # @!attribute [rw] zip
+        #   @return [::Google::Cloud::AppEngine::V1::ZipInfo]
+        #     The zip file for this deployment, if this is a zip deployment.
+        # @!attribute [rw] cloud_build_options
+        #   @return [::Google::Cloud::AppEngine::V1::CloudBuildOptions]
+        #     Options for any Google Cloud Build builds created as a part of this
+        #     deployment.
+        #
+        #     These options will only be used if a new build is created, such as when
+        #     deploying to the App Engine flexible environment using files or zip.
+        class Deployment
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::AppEngine::V1::FileInfo]
+          class FilesEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Single source file that is part of the version to be deployed. Each source
+        # file that is deployed must be specified separately.
+        # @!attribute [rw] source_url
+        #   @return [::String]
+        #     URL source to use to fetch this file. Must be a URL to a resource in
+        #     Google Cloud Storage in the form
+        #     'http(s)://storage.googleapis.com/\<bucket\>/\<object\>'.
+        # @!attribute [rw] sha1_sum
+        #   @return [::String]
+        #     The SHA1 hash of the file, in hex.
+        # @!attribute [rw] mime_type
+        #   @return [::String]
+        #     The MIME type of the file.
+        #
+        #     Defaults to the value from Google Cloud Storage.
+        class FileInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Docker image that is used to create a container and start a VM instance for
+        # the version that you deploy. Only applicable for instances running in the App
+        # Engine flexible environment.
+        # @!attribute [rw] image
+        #   @return [::String]
+        #     URI to the hosted container image in Google Container Registry. The URI
+        #     must be fully qualified and include a tag or digest.
+        #     Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
+        class ContainerInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Options for the build operations performed as a part of the version
+        # deployment. Only applicable for App Engine flexible environment when creating
+        # a version using source code directly.
+        # @!attribute [rw] app_yaml_path
+        #   @return [::String]
+        #     Path to the yaml file used in deployment, used to determine runtime
+        #     configuration details.
+        #
+        #     Required for flexible environment builds.
+        #
+        #     See https://cloud.google.com/appengine/docs/standard/python/config/appref
+        #     for more details.
+        # @!attribute [rw] cloud_build_timeout
+        #   @return [::Google::Protobuf::Duration]
+        #     The Cloud Build timeout used as part of any dependent builds performed by
+        #     version creation. Defaults to 10 minutes.
+        class CloudBuildOptions
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The zip file information for a zip deployment.
+        # @!attribute [rw] source_url
+        #   @return [::String]
+        #     URL of the zip file to deploy from. Must be a URL to a resource in
+        #     Google Cloud Storage in the form
+        #     'http(s)://storage.googleapis.com/\<bucket\>/\<object\>'.
+        # @!attribute [rw] files_count
+        #   @return [::Integer]
+        #     An estimate of the number of files in a zip for a zip deployment.
+        #     If set, must be greater than or equal to the actual number of files.
+        #     Used for optimizing performance; if not provided, deployment may be slow.
+        class ZipInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end