google-cloud-app_engine-v1 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +169 -0
- data/LICENSE.md +201 -0
- data/README.md +139 -0
- data/lib/google-cloud-app_engine-v1.rb +21 -0
- data/lib/google/appengine/v1/app_yaml_pb.rb +137 -0
- data/lib/google/appengine/v1/appengine_pb.rb +261 -0
- data/lib/google/appengine/v1/appengine_services_pb.rb +313 -0
- data/lib/google/appengine/v1/application_pb.rb +69 -0
- data/lib/google/appengine/v1/audit_data_pb.rb +35 -0
- data/lib/google/appengine/v1/certificate_pb.rb +52 -0
- data/lib/google/appengine/v1/deploy_pb.rb +47 -0
- data/lib/google/appengine/v1/deployed_files_pb.rb +19 -0
- data/lib/google/appengine/v1/domain_mapping_pb.rb +51 -0
- data/lib/google/appengine/v1/domain_pb.rb +24 -0
- data/lib/google/appengine/v1/firewall_pb.rb +32 -0
- data/lib/google/appengine/v1/instance_pb.rb +45 -0
- data/lib/google/appengine/v1/location_pb.rb +24 -0
- data/lib/google/appengine/v1/network_settings_pb.rb +19 -0
- data/lib/google/appengine/v1/operation_pb.rb +37 -0
- data/lib/google/appengine/v1/service_pb.rb +37 -0
- data/lib/google/appengine/v1/version_pb.rb +183 -0
- data/lib/google/cloud/app_engine/v1.rb +45 -0
- data/lib/google/cloud/app_engine/v1/applications.rb +49 -0
- data/lib/google/cloud/app_engine/v1/applications/client.rb +624 -0
- data/lib/google/cloud/app_engine/v1/applications/credentials.rb +53 -0
- data/lib/google/cloud/app_engine/v1/applications/operations.rb +655 -0
- data/lib/google/cloud/app_engine/v1/authorized_certificates.rb +49 -0
- data/lib/google/cloud/app_engine/v1/authorized_certificates/client.rb +690 -0
- data/lib/google/cloud/app_engine/v1/authorized_certificates/credentials.rb +53 -0
- data/lib/google/cloud/app_engine/v1/authorized_domains.rb +50 -0
- data/lib/google/cloud/app_engine/v1/authorized_domains/client.rb +380 -0
- data/lib/google/cloud/app_engine/v1/authorized_domains/credentials.rb +53 -0
- data/lib/google/cloud/app_engine/v1/domain_mappings.rb +49 -0
- data/lib/google/cloud/app_engine/v1/domain_mappings/client.rb +705 -0
- data/lib/google/cloud/app_engine/v1/domain_mappings/credentials.rb +53 -0
- data/lib/google/cloud/app_engine/v1/domain_mappings/operations.rb +655 -0
- data/lib/google/cloud/app_engine/v1/firewall.rb +57 -0
- data/lib/google/cloud/app_engine/v1/firewall/client.rb +783 -0
- data/lib/google/cloud/app_engine/v1/firewall/credentials.rb +53 -0
- data/lib/google/cloud/app_engine/v1/instances.rb +49 -0
- data/lib/google/cloud/app_engine/v1/instances/client.rb +644 -0
- data/lib/google/cloud/app_engine/v1/instances/credentials.rb +53 -0
- data/lib/google/cloud/app_engine/v1/instances/operations.rb +655 -0
- data/lib/google/cloud/app_engine/v1/services.rb +49 -0
- data/lib/google/cloud/app_engine/v1/services/client.rb +629 -0
- data/lib/google/cloud/app_engine/v1/services/credentials.rb +53 -0
- data/lib/google/cloud/app_engine/v1/services/operations.rb +655 -0
- data/lib/google/cloud/app_engine/v1/version.rb +28 -0
- data/lib/google/cloud/app_engine/v1/versions.rb +49 -0
- data/lib/google/cloud/app_engine/v1/versions/client.rb +738 -0
- data/lib/google/cloud/app_engine/v1/versions/credentials.rb +53 -0
- data/lib/google/cloud/app_engine/v1/versions/operations.rb +655 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/resource.rb +283 -0
- data/proto_docs/google/appengine/v1/app_yaml.rb +379 -0
- data/proto_docs/google/appengine/v1/appengine.rb +639 -0
- data/proto_docs/google/appengine/v1/application.rb +192 -0
- data/proto_docs/google/appengine/v1/audit_data.rb +56 -0
- data/proto_docs/google/appengine/v1/certificate.rb +161 -0
- data/proto_docs/google/appengine/v1/deploy.rb +130 -0
- data/proto_docs/google/appengine/v1/domain.rb +42 -0
- data/proto_docs/google/appengine/v1/domain_mapping.rb +127 -0
- data/proto_docs/google/appengine/v1/firewall.rb +72 -0
- data/proto_docs/google/appengine/v1/instance.rb +98 -0
- data/proto_docs/google/appengine/v1/location.rb +38 -0
- data/proto_docs/google/appengine/v1/operation.rb +67 -0
- data/proto_docs/google/appengine/v1/service.rb +100 -0
- data/proto_docs/google/appengine/v1/version.rb +597 -0
- data/proto_docs/google/longrunning/operations.rb +164 -0
- data/proto_docs/google/protobuf/any.rb +141 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +36 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +129 -0
- data/proto_docs/google/rpc/status.rb +46 -0
- metadata +261 -0
@@ -0,0 +1,283 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2021 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Api
|
22
|
+
# A simple descriptor of a resource type.
|
23
|
+
#
|
24
|
+
# ResourceDescriptor annotates a resource message (either by means of a
|
25
|
+
# protobuf annotation or use in the service config), and associates the
|
26
|
+
# resource's schema, the resource type, and the pattern of the resource name.
|
27
|
+
#
|
28
|
+
# Example:
|
29
|
+
#
|
30
|
+
# message Topic {
|
31
|
+
# // Indicates this message defines a resource schema.
|
32
|
+
# // Declares the resource type in the format of {service}/{kind}.
|
33
|
+
# // For Kubernetes resources, the format is {api group}/{kind}.
|
34
|
+
# option (google.api.resource) = {
|
35
|
+
# type: "pubsub.googleapis.com/Topic"
|
36
|
+
# name_descriptor: {
|
37
|
+
# pattern: "projects/{project}/topics/{topic}"
|
38
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
39
|
+
# parent_name_extractor: "projects/{project}"
|
40
|
+
# }
|
41
|
+
# };
|
42
|
+
# }
|
43
|
+
#
|
44
|
+
# The ResourceDescriptor Yaml config will look like:
|
45
|
+
#
|
46
|
+
# resources:
|
47
|
+
# - type: "pubsub.googleapis.com/Topic"
|
48
|
+
# name_descriptor:
|
49
|
+
# - pattern: "projects/{project}/topics/{topic}"
|
50
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
51
|
+
# parent_name_extractor: "projects/{project}"
|
52
|
+
#
|
53
|
+
# Sometimes, resources have multiple patterns, typically because they can
|
54
|
+
# live under multiple parents.
|
55
|
+
#
|
56
|
+
# Example:
|
57
|
+
#
|
58
|
+
# message LogEntry {
|
59
|
+
# option (google.api.resource) = {
|
60
|
+
# type: "logging.googleapis.com/LogEntry"
|
61
|
+
# name_descriptor: {
|
62
|
+
# pattern: "projects/{project}/logs/{log}"
|
63
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
64
|
+
# parent_name_extractor: "projects/{project}"
|
65
|
+
# }
|
66
|
+
# name_descriptor: {
|
67
|
+
# pattern: "folders/{folder}/logs/{log}"
|
68
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
69
|
+
# parent_name_extractor: "folders/{folder}"
|
70
|
+
# }
|
71
|
+
# name_descriptor: {
|
72
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
73
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
74
|
+
# parent_name_extractor: "organizations/{organization}"
|
75
|
+
# }
|
76
|
+
# name_descriptor: {
|
77
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
78
|
+
# parent_type: "billing.googleapis.com/BillingAccount"
|
79
|
+
# parent_name_extractor: "billingAccounts/{billing_account}"
|
80
|
+
# }
|
81
|
+
# };
|
82
|
+
# }
|
83
|
+
#
|
84
|
+
# The ResourceDescriptor Yaml config will look like:
|
85
|
+
#
|
86
|
+
# resources:
|
87
|
+
# - type: 'logging.googleapis.com/LogEntry'
|
88
|
+
# name_descriptor:
|
89
|
+
# - pattern: "projects/{project}/logs/{log}"
|
90
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
91
|
+
# parent_name_extractor: "projects/{project}"
|
92
|
+
# - pattern: "folders/{folder}/logs/{log}"
|
93
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
94
|
+
# parent_name_extractor: "folders/{folder}"
|
95
|
+
# - pattern: "organizations/{organization}/logs/{log}"
|
96
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Organization"
|
97
|
+
# parent_name_extractor: "organizations/{organization}"
|
98
|
+
# - pattern: "billingAccounts/{billing_account}/logs/{log}"
|
99
|
+
# parent_type: "billing.googleapis.com/BillingAccount"
|
100
|
+
# parent_name_extractor: "billingAccounts/{billing_account}"
|
101
|
+
#
|
102
|
+
# For flexible resources, the resource name doesn't contain parent names, but
|
103
|
+
# the resource itself has parents for policy evaluation.
|
104
|
+
#
|
105
|
+
# Example:
|
106
|
+
#
|
107
|
+
# message Shelf {
|
108
|
+
# option (google.api.resource) = {
|
109
|
+
# type: "library.googleapis.com/Shelf"
|
110
|
+
# name_descriptor: {
|
111
|
+
# pattern: "shelves/{shelf}"
|
112
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
113
|
+
# }
|
114
|
+
# name_descriptor: {
|
115
|
+
# pattern: "shelves/{shelf}"
|
116
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
117
|
+
# }
|
118
|
+
# };
|
119
|
+
# }
|
120
|
+
#
|
121
|
+
# The ResourceDescriptor Yaml config will look like:
|
122
|
+
#
|
123
|
+
# resources:
|
124
|
+
# - type: 'library.googleapis.com/Shelf'
|
125
|
+
# name_descriptor:
|
126
|
+
# - pattern: "shelves/{shelf}"
|
127
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
128
|
+
# - pattern: "shelves/{shelf}"
|
129
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Folder"
|
130
|
+
# @!attribute [rw] type
|
131
|
+
# @return [::String]
|
132
|
+
# The resource type. It must be in the format of
|
133
|
+
# \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
|
134
|
+
# singular and must not include version numbers.
|
135
|
+
#
|
136
|
+
# Example: `storage.googleapis.com/Bucket`
|
137
|
+
#
|
138
|
+
# The value of the resource_type_kind must follow the regular expression
|
139
|
+
# /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
|
140
|
+
# should use PascalCase (UpperCamelCase). The maximum number of
|
141
|
+
# characters allowed for the `resource_type_kind` is 100.
|
142
|
+
# @!attribute [rw] pattern
|
143
|
+
# @return [::Array<::String>]
|
144
|
+
# Optional. The relative resource name pattern associated with this resource
|
145
|
+
# type. The DNS prefix of the full resource name shouldn't be specified here.
|
146
|
+
#
|
147
|
+
# The path pattern must follow the syntax, which aligns with HTTP binding
|
148
|
+
# syntax:
|
149
|
+
#
|
150
|
+
# Template = Segment { "/" Segment } ;
|
151
|
+
# Segment = LITERAL | Variable ;
|
152
|
+
# Variable = "{" LITERAL "}" ;
|
153
|
+
#
|
154
|
+
# Examples:
|
155
|
+
#
|
156
|
+
# - "projects/\\{project}/topics/\\{topic}"
|
157
|
+
# - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
|
158
|
+
#
|
159
|
+
# The components in braces correspond to the IDs for each resource in the
|
160
|
+
# hierarchy. It is expected that, if multiple patterns are provided,
|
161
|
+
# the same component name (e.g. "project") refers to IDs of the same
|
162
|
+
# type of resource.
|
163
|
+
# @!attribute [rw] name_field
|
164
|
+
# @return [::String]
|
165
|
+
# Optional. The field on the resource that designates the resource name
|
166
|
+
# field. If omitted, this is assumed to be "name".
|
167
|
+
# @!attribute [rw] history
|
168
|
+
# @return [::Google::Api::ResourceDescriptor::History]
|
169
|
+
# Optional. The historical or future-looking state of the resource pattern.
|
170
|
+
#
|
171
|
+
# Example:
|
172
|
+
#
|
173
|
+
# // The InspectTemplate message originally only supported resource
|
174
|
+
# // names with organization, and project was added later.
|
175
|
+
# message InspectTemplate {
|
176
|
+
# option (google.api.resource) = {
|
177
|
+
# type: "dlp.googleapis.com/InspectTemplate"
|
178
|
+
# pattern:
|
179
|
+
# "organizations/{organization}/inspectTemplates/{inspect_template}"
|
180
|
+
# pattern: "projects/{project}/inspectTemplates/{inspect_template}"
|
181
|
+
# history: ORIGINALLY_SINGLE_PATTERN
|
182
|
+
# };
|
183
|
+
# }
|
184
|
+
# @!attribute [rw] plural
|
185
|
+
# @return [::String]
|
186
|
+
# The plural name used in the resource name and permission names, such as
|
187
|
+
# 'projects' for the resource name of 'projects/\\{project}' and the permission
|
188
|
+
# name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
|
189
|
+
# concept of the `plural` field in k8s CRD spec
|
190
|
+
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
191
|
+
#
|
192
|
+
# Note: The plural form is required even for singleton resources. See
|
193
|
+
# https://aip.dev/156
|
194
|
+
# @!attribute [rw] singular
|
195
|
+
# @return [::String]
|
196
|
+
# The same concept of the `singular` field in k8s CRD spec
|
197
|
+
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
198
|
+
# Such as "project" for the `resourcemanager.googleapis.com/Project` type.
|
199
|
+
# @!attribute [rw] style
|
200
|
+
# @return [::Array<::Google::Api::ResourceDescriptor::Style>]
|
201
|
+
# Style flag(s) for this resource.
|
202
|
+
# These indicate that a resource is expected to conform to a given
|
203
|
+
# style. See the specific style flags for additional information.
|
204
|
+
class ResourceDescriptor
|
205
|
+
include ::Google::Protobuf::MessageExts
|
206
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
207
|
+
|
208
|
+
# A description of the historical or future-looking state of the
|
209
|
+
# resource pattern.
|
210
|
+
module History
|
211
|
+
# The "unset" value.
|
212
|
+
HISTORY_UNSPECIFIED = 0
|
213
|
+
|
214
|
+
# The resource originally had one pattern and launched as such, and
|
215
|
+
# additional patterns were added later.
|
216
|
+
ORIGINALLY_SINGLE_PATTERN = 1
|
217
|
+
|
218
|
+
# The resource has one pattern, but the API owner expects to add more
|
219
|
+
# later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
|
220
|
+
# that from being necessary once there are multiple patterns.)
|
221
|
+
FUTURE_MULTI_PATTERN = 2
|
222
|
+
end
|
223
|
+
|
224
|
+
# A flag representing a specific style that a resource claims to conform to.
|
225
|
+
module Style
|
226
|
+
# The unspecified value. Do not use.
|
227
|
+
STYLE_UNSPECIFIED = 0
|
228
|
+
|
229
|
+
# This resource is intended to be "declarative-friendly".
|
230
|
+
#
|
231
|
+
# Declarative-friendly resources must be more strictly consistent, and
|
232
|
+
# setting this to true communicates to tools that this resource should
|
233
|
+
# adhere to declarative-friendly expectations.
|
234
|
+
#
|
235
|
+
# Note: This is used by the API linter (linter.aip.dev) to enable
|
236
|
+
# additional checks.
|
237
|
+
DECLARATIVE_FRIENDLY = 1
|
238
|
+
end
|
239
|
+
end
|
240
|
+
|
241
|
+
# Defines a proto annotation that describes a string field that refers to
|
242
|
+
# an API resource.
|
243
|
+
# @!attribute [rw] type
|
244
|
+
# @return [::String]
|
245
|
+
# The resource type that the annotated field references.
|
246
|
+
#
|
247
|
+
# Example:
|
248
|
+
#
|
249
|
+
# message Subscription {
|
250
|
+
# string topic = 2 [(google.api.resource_reference) = {
|
251
|
+
# type: "pubsub.googleapis.com/Topic"
|
252
|
+
# }];
|
253
|
+
# }
|
254
|
+
#
|
255
|
+
# Occasionally, a field may reference an arbitrary resource. In this case,
|
256
|
+
# APIs use the special value * in their resource reference.
|
257
|
+
#
|
258
|
+
# Example:
|
259
|
+
#
|
260
|
+
# message GetIamPolicyRequest {
|
261
|
+
# string resource = 2 [(google.api.resource_reference) = {
|
262
|
+
# type: "*"
|
263
|
+
# }];
|
264
|
+
# }
|
265
|
+
# @!attribute [rw] child_type
|
266
|
+
# @return [::String]
|
267
|
+
# The resource type of a child collection that the annotated field
|
268
|
+
# references. This is useful for annotating the `parent` field that
|
269
|
+
# doesn't have a fixed resource type.
|
270
|
+
#
|
271
|
+
# Example:
|
272
|
+
#
|
273
|
+
# message ListLogEntriesRequest {
|
274
|
+
# string parent = 1 [(google.api.resource_reference) = {
|
275
|
+
# child_type: "logging.googleapis.com/LogEntry"
|
276
|
+
# };
|
277
|
+
# }
|
278
|
+
class ResourceReference
|
279
|
+
include ::Google::Protobuf::MessageExts
|
280
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
281
|
+
end
|
282
|
+
end
|
283
|
+
end
|
@@ -0,0 +1,379 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2021 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module AppEngine
|
23
|
+
module V1
|
24
|
+
# [Google Cloud Endpoints](https://cloud.google.com/appengine/docs/python/endpoints/)
|
25
|
+
# configuration for API handlers.
|
26
|
+
# @!attribute [rw] auth_fail_action
|
27
|
+
# @return [::Google::Cloud::AppEngine::V1::AuthFailAction]
|
28
|
+
# Action to take when users access resources that require
|
29
|
+
# authentication. Defaults to `redirect`.
|
30
|
+
# @!attribute [rw] login
|
31
|
+
# @return [::Google::Cloud::AppEngine::V1::LoginRequirement]
|
32
|
+
# Level of login required to access this resource. Defaults to
|
33
|
+
# `optional`.
|
34
|
+
# @!attribute [rw] script
|
35
|
+
# @return [::String]
|
36
|
+
# Path to the script from the application root directory.
|
37
|
+
# @!attribute [rw] security_level
|
38
|
+
# @return [::Google::Cloud::AppEngine::V1::SecurityLevel]
|
39
|
+
# Security (HTTPS) enforcement for this URL.
|
40
|
+
# @!attribute [rw] url
|
41
|
+
# @return [::String]
|
42
|
+
# URL to serve the endpoint at.
|
43
|
+
class ApiConfigHandler
|
44
|
+
include ::Google::Protobuf::MessageExts
|
45
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
46
|
+
end
|
47
|
+
|
48
|
+
# Custom static error page to be served when an error occurs.
|
49
|
+
# @!attribute [rw] error_code
|
50
|
+
# @return [::Google::Cloud::AppEngine::V1::ErrorHandler::ErrorCode]
|
51
|
+
# Error condition this handler applies to.
|
52
|
+
# @!attribute [rw] static_file
|
53
|
+
# @return [::String]
|
54
|
+
# Static file content to be served for this error.
|
55
|
+
# @!attribute [rw] mime_type
|
56
|
+
# @return [::String]
|
57
|
+
# MIME type of file. Defaults to `text/html`.
|
58
|
+
class ErrorHandler
|
59
|
+
include ::Google::Protobuf::MessageExts
|
60
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
61
|
+
|
62
|
+
# Error codes.
|
63
|
+
module ErrorCode
|
64
|
+
# Not specified. ERROR_CODE_DEFAULT is assumed.
|
65
|
+
ERROR_CODE_UNSPECIFIED = 0
|
66
|
+
|
67
|
+
# All other error types.
|
68
|
+
ERROR_CODE_DEFAULT = 0
|
69
|
+
|
70
|
+
# Application has exceeded a resource quota.
|
71
|
+
ERROR_CODE_OVER_QUOTA = 1
|
72
|
+
|
73
|
+
# Client blocked by the application's Denial of Service protection
|
74
|
+
# configuration.
|
75
|
+
ERROR_CODE_DOS_API_DENIAL = 2
|
76
|
+
|
77
|
+
# Deadline reached before the application responds.
|
78
|
+
ERROR_CODE_TIMEOUT = 3
|
79
|
+
end
|
80
|
+
end
|
81
|
+
|
82
|
+
# URL pattern and description of how the URL should be handled. App Engine can
|
83
|
+
# handle URLs by executing application code or by serving static files
|
84
|
+
# uploaded with the version, such as images, CSS, or JavaScript.
|
85
|
+
# @!attribute [rw] url_regex
|
86
|
+
# @return [::String]
|
87
|
+
# URL prefix. Uses regular expression syntax, which means regexp
|
88
|
+
# special characters must be escaped, but should not contain groupings.
|
89
|
+
# All URLs that begin with this prefix are handled by this handler, using the
|
90
|
+
# portion of the URL after the prefix as part of the file path.
|
91
|
+
# @!attribute [rw] static_files
|
92
|
+
# @return [::Google::Cloud::AppEngine::V1::StaticFilesHandler]
|
93
|
+
# Returns the contents of a file, such as an image, as the response.
|
94
|
+
# @!attribute [rw] script
|
95
|
+
# @return [::Google::Cloud::AppEngine::V1::ScriptHandler]
|
96
|
+
# Executes a script to handle the requests that match this URL
|
97
|
+
# pattern. Only the `auto` value is supported for Node.js in the
|
98
|
+
# App Engine standard environment, for example `"script": "auto"`.
|
99
|
+
# @!attribute [rw] api_endpoint
|
100
|
+
# @return [::Google::Cloud::AppEngine::V1::ApiEndpointHandler]
|
101
|
+
# Uses API Endpoints to handle requests.
|
102
|
+
# @!attribute [rw] security_level
|
103
|
+
# @return [::Google::Cloud::AppEngine::V1::SecurityLevel]
|
104
|
+
# Security (HTTPS) enforcement for this URL.
|
105
|
+
# @!attribute [rw] login
|
106
|
+
# @return [::Google::Cloud::AppEngine::V1::LoginRequirement]
|
107
|
+
# Level of login required to access this resource. Not supported for Node.js
|
108
|
+
# in the App Engine standard environment.
|
109
|
+
# @!attribute [rw] auth_fail_action
|
110
|
+
# @return [::Google::Cloud::AppEngine::V1::AuthFailAction]
|
111
|
+
# Action to take when users access resources that require
|
112
|
+
# authentication. Defaults to `redirect`.
|
113
|
+
# @!attribute [rw] redirect_http_response_code
|
114
|
+
# @return [::Google::Cloud::AppEngine::V1::UrlMap::RedirectHttpResponseCode]
|
115
|
+
# `30x` code to use when performing redirects for the `secure` field.
|
116
|
+
# Defaults to `302`.
|
117
|
+
class UrlMap
|
118
|
+
include ::Google::Protobuf::MessageExts
|
119
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
120
|
+
|
121
|
+
# Redirect codes.
|
122
|
+
module RedirectHttpResponseCode
|
123
|
+
# Not specified. `302` is assumed.
|
124
|
+
REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED = 0
|
125
|
+
|
126
|
+
# `301 Moved Permanently` code.
|
127
|
+
REDIRECT_HTTP_RESPONSE_CODE_301 = 1
|
128
|
+
|
129
|
+
# `302 Moved Temporarily` code.
|
130
|
+
REDIRECT_HTTP_RESPONSE_CODE_302 = 2
|
131
|
+
|
132
|
+
# `303 See Other` code.
|
133
|
+
REDIRECT_HTTP_RESPONSE_CODE_303 = 3
|
134
|
+
|
135
|
+
# `307 Temporary Redirect` code.
|
136
|
+
REDIRECT_HTTP_RESPONSE_CODE_307 = 4
|
137
|
+
end
|
138
|
+
end
|
139
|
+
|
140
|
+
# Files served directly to the user for a given URL, such as images, CSS
|
141
|
+
# stylesheets, or JavaScript source files. Static file handlers describe which
|
142
|
+
# files in the application directory are static files, and which URLs serve
|
143
|
+
# them.
|
144
|
+
# @!attribute [rw] path
|
145
|
+
# @return [::String]
|
146
|
+
# Path to the static files matched by the URL pattern, from the
|
147
|
+
# application root directory. The path can refer to text matched in groupings
|
148
|
+
# in the URL pattern.
|
149
|
+
# @!attribute [rw] upload_path_regex
|
150
|
+
# @return [::String]
|
151
|
+
# Regular expression that matches the file paths for all files that should be
|
152
|
+
# referenced by this handler.
|
153
|
+
# @!attribute [rw] http_headers
|
154
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
155
|
+
# HTTP headers to use for all responses from these URLs.
|
156
|
+
# @!attribute [rw] mime_type
|
157
|
+
# @return [::String]
|
158
|
+
# MIME type used to serve all files served by this handler.
|
159
|
+
#
|
160
|
+
# Defaults to file-specific MIME types, which are derived from each file's
|
161
|
+
# filename extension.
|
162
|
+
# @!attribute [rw] expiration
|
163
|
+
# @return [::Google::Protobuf::Duration]
|
164
|
+
# Time a static file served by this handler should be cached
|
165
|
+
# by web proxies and browsers.
|
166
|
+
# @!attribute [rw] require_matching_file
|
167
|
+
# @return [::Boolean]
|
168
|
+
# Whether this handler should match the request if the file
|
169
|
+
# referenced by the handler does not exist.
|
170
|
+
# @!attribute [rw] application_readable
|
171
|
+
# @return [::Boolean]
|
172
|
+
# Whether files should also be uploaded as code data. By default, files
|
173
|
+
# declared in static file handlers are uploaded as static
|
174
|
+
# data and are only served to end users; they cannot be read by the
|
175
|
+
# application. If enabled, uploads are charged against both your code and
|
176
|
+
# static data storage resource quotas.
|
177
|
+
class StaticFilesHandler
|
178
|
+
include ::Google::Protobuf::MessageExts
|
179
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
180
|
+
|
181
|
+
# @!attribute [rw] key
|
182
|
+
# @return [::String]
|
183
|
+
# @!attribute [rw] value
|
184
|
+
# @return [::String]
|
185
|
+
class HttpHeadersEntry
|
186
|
+
include ::Google::Protobuf::MessageExts
|
187
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
188
|
+
end
|
189
|
+
end
|
190
|
+
|
191
|
+
# Executes a script to handle the request that matches the URL pattern.
|
192
|
+
# @!attribute [rw] script_path
|
193
|
+
# @return [::String]
|
194
|
+
# Path to the script from the application root directory.
|
195
|
+
class ScriptHandler
|
196
|
+
include ::Google::Protobuf::MessageExts
|
197
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
198
|
+
end
|
199
|
+
|
200
|
+
# Uses Google Cloud Endpoints to handle requests.
|
201
|
+
# @!attribute [rw] script_path
|
202
|
+
# @return [::String]
|
203
|
+
# Path to the script from the application root directory.
|
204
|
+
class ApiEndpointHandler
|
205
|
+
include ::Google::Protobuf::MessageExts
|
206
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
207
|
+
end
|
208
|
+
|
209
|
+
# Health checking configuration for VM instances. Unhealthy instances
|
210
|
+
# are killed and replaced with new instances. Only applicable for
|
211
|
+
# instances in App Engine flexible environment.
|
212
|
+
# @!attribute [rw] disable_health_check
|
213
|
+
# @return [::Boolean]
|
214
|
+
# Whether to explicitly disable health checks for this instance.
|
215
|
+
# @!attribute [rw] host
|
216
|
+
# @return [::String]
|
217
|
+
# Host header to send when performing an HTTP health check.
|
218
|
+
# Example: "myapp.appspot.com"
|
219
|
+
# @!attribute [rw] healthy_threshold
|
220
|
+
# @return [::Integer]
|
221
|
+
# Number of consecutive successful health checks required before receiving
|
222
|
+
# traffic.
|
223
|
+
# @!attribute [rw] unhealthy_threshold
|
224
|
+
# @return [::Integer]
|
225
|
+
# Number of consecutive failed health checks required before removing
|
226
|
+
# traffic.
|
227
|
+
# @!attribute [rw] restart_threshold
|
228
|
+
# @return [::Integer]
|
229
|
+
# Number of consecutive failed health checks required before an instance is
|
230
|
+
# restarted.
|
231
|
+
# @!attribute [rw] check_interval
|
232
|
+
# @return [::Google::Protobuf::Duration]
|
233
|
+
# Interval between health checks.
|
234
|
+
# @!attribute [rw] timeout
|
235
|
+
# @return [::Google::Protobuf::Duration]
|
236
|
+
# Time before the health check is considered failed.
|
237
|
+
class HealthCheck
|
238
|
+
include ::Google::Protobuf::MessageExts
|
239
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
240
|
+
end
|
241
|
+
|
242
|
+
# Readiness checking configuration for VM instances. Unhealthy instances
|
243
|
+
# are removed from traffic rotation.
|
244
|
+
# @!attribute [rw] path
|
245
|
+
# @return [::String]
|
246
|
+
# The request path.
|
247
|
+
# @!attribute [rw] host
|
248
|
+
# @return [::String]
|
249
|
+
# Host header to send when performing a HTTP Readiness check.
|
250
|
+
# Example: "myapp.appspot.com"
|
251
|
+
# @!attribute [rw] failure_threshold
|
252
|
+
# @return [::Integer]
|
253
|
+
# Number of consecutive failed checks required before removing
|
254
|
+
# traffic.
|
255
|
+
# @!attribute [rw] success_threshold
|
256
|
+
# @return [::Integer]
|
257
|
+
# Number of consecutive successful checks required before receiving
|
258
|
+
# traffic.
|
259
|
+
# @!attribute [rw] check_interval
|
260
|
+
# @return [::Google::Protobuf::Duration]
|
261
|
+
# Interval between health checks.
|
262
|
+
# @!attribute [rw] timeout
|
263
|
+
# @return [::Google::Protobuf::Duration]
|
264
|
+
# Time before the check is considered failed.
|
265
|
+
# @!attribute [rw] app_start_timeout
|
266
|
+
# @return [::Google::Protobuf::Duration]
|
267
|
+
# A maximum time limit on application initialization, measured from moment
|
268
|
+
# the application successfully replies to a healthcheck until it is ready to
|
269
|
+
# serve traffic.
|
270
|
+
class ReadinessCheck
|
271
|
+
include ::Google::Protobuf::MessageExts
|
272
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
273
|
+
end
|
274
|
+
|
275
|
+
# Health checking configuration for VM instances. Unhealthy instances
|
276
|
+
# are killed and replaced with new instances.
|
277
|
+
# @!attribute [rw] path
|
278
|
+
# @return [::String]
|
279
|
+
# The request path.
|
280
|
+
# @!attribute [rw] host
|
281
|
+
# @return [::String]
|
282
|
+
# Host header to send when performing a HTTP Liveness check.
|
283
|
+
# Example: "myapp.appspot.com"
|
284
|
+
# @!attribute [rw] failure_threshold
|
285
|
+
# @return [::Integer]
|
286
|
+
# Number of consecutive failed checks required before considering the
|
287
|
+
# VM unhealthy.
|
288
|
+
# @!attribute [rw] success_threshold
|
289
|
+
# @return [::Integer]
|
290
|
+
# Number of consecutive successful checks required before considering
|
291
|
+
# the VM healthy.
|
292
|
+
# @!attribute [rw] check_interval
|
293
|
+
# @return [::Google::Protobuf::Duration]
|
294
|
+
# Interval between health checks.
|
295
|
+
# @!attribute [rw] timeout
|
296
|
+
# @return [::Google::Protobuf::Duration]
|
297
|
+
# Time before the check is considered failed.
|
298
|
+
# @!attribute [rw] initial_delay
|
299
|
+
# @return [::Google::Protobuf::Duration]
|
300
|
+
# The initial delay before starting to execute the checks.
|
301
|
+
class LivenessCheck
|
302
|
+
include ::Google::Protobuf::MessageExts
|
303
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
304
|
+
end
|
305
|
+
|
306
|
+
# Third-party Python runtime library that is required by the application.
|
307
|
+
# @!attribute [rw] name
|
308
|
+
# @return [::String]
|
309
|
+
# Name of the library. Example: "django".
|
310
|
+
# @!attribute [rw] version
|
311
|
+
# @return [::String]
|
312
|
+
# Version of the library to select, or "latest".
|
313
|
+
class Library
|
314
|
+
include ::Google::Protobuf::MessageExts
|
315
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
316
|
+
end
|
317
|
+
|
318
|
+
# Actions to take when the user is not logged in.
|
319
|
+
module AuthFailAction
|
320
|
+
# Not specified. `AUTH_FAIL_ACTION_REDIRECT` is assumed.
|
321
|
+
AUTH_FAIL_ACTION_UNSPECIFIED = 0
|
322
|
+
|
323
|
+
# Redirects user to "accounts.google.com". The user is redirected back to the
|
324
|
+
# application URL after signing in or creating an account.
|
325
|
+
AUTH_FAIL_ACTION_REDIRECT = 1
|
326
|
+
|
327
|
+
# Rejects request with a `401` HTTP status code and an error
|
328
|
+
# message.
|
329
|
+
AUTH_FAIL_ACTION_UNAUTHORIZED = 2
|
330
|
+
end
|
331
|
+
|
332
|
+
# Methods to restrict access to a URL based on login status.
|
333
|
+
module LoginRequirement
|
334
|
+
# Not specified. `LOGIN_OPTIONAL` is assumed.
|
335
|
+
LOGIN_UNSPECIFIED = 0
|
336
|
+
|
337
|
+
# Does not require that the user is signed in.
|
338
|
+
LOGIN_OPTIONAL = 1
|
339
|
+
|
340
|
+
# If the user is not signed in, the `auth_fail_action` is taken.
|
341
|
+
# In addition, if the user is not an administrator for the
|
342
|
+
# application, they are given an error message regardless of
|
343
|
+
# `auth_fail_action`. If the user is an administrator, the handler
|
344
|
+
# proceeds.
|
345
|
+
LOGIN_ADMIN = 2
|
346
|
+
|
347
|
+
# If the user has signed in, the handler proceeds normally. Otherwise, the
|
348
|
+
# auth_fail_action is taken.
|
349
|
+
LOGIN_REQUIRED = 3
|
350
|
+
end
|
351
|
+
|
352
|
+
# Methods to enforce security (HTTPS) on a URL.
|
353
|
+
module SecurityLevel
|
354
|
+
# Not specified.
|
355
|
+
SECURE_UNSPECIFIED = 0
|
356
|
+
|
357
|
+
# Both HTTP and HTTPS requests with URLs that match the handler succeed
|
358
|
+
# without redirects. The application can examine the request to determine
|
359
|
+
# which protocol was used, and respond accordingly.
|
360
|
+
SECURE_DEFAULT = 0
|
361
|
+
|
362
|
+
# Requests for a URL that match this handler that use HTTPS are automatically
|
363
|
+
# redirected to the HTTP equivalent URL.
|
364
|
+
SECURE_NEVER = 1
|
365
|
+
|
366
|
+
# Both HTTP and HTTPS requests with URLs that match the handler succeed
|
367
|
+
# without redirects. The application can examine the request to determine
|
368
|
+
# which protocol was used and respond accordingly.
|
369
|
+
SECURE_OPTIONAL = 2
|
370
|
+
|
371
|
+
# Requests for a URL that match this handler that do not use HTTPS are
|
372
|
+
# automatically redirected to the HTTPS URL with the same path. Query
|
373
|
+
# parameters are reserved for the redirect.
|
374
|
+
SECURE_ALWAYS = 3
|
375
|
+
end
|
376
|
+
end
|
377
|
+
end
|
378
|
+
end
|
379
|
+
end
|