google-cloud-shell-v1 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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-shell-v1.rb +21 -0
- data/lib/google/cloud/shell/v1.rb +38 -0
- data/lib/google/cloud/shell/v1/cloud_shell_service.rb +56 -0
- data/lib/google/cloud/shell/v1/cloud_shell_service/client.rb +748 -0
- data/lib/google/cloud/shell/v1/cloud_shell_service/credentials.rb +51 -0
- data/lib/google/cloud/shell/v1/cloud_shell_service/operations.rb +655 -0
- data/lib/google/cloud/shell/v1/cloud_shell_service/paths.rb +50 -0
- data/lib/google/cloud/shell/v1/cloudshell_pb.rb +125 -0
- data/lib/google/cloud/shell/v1/cloudshell_services_pb.rb +72 -0
- data/lib/google/cloud/shell/v1/version.rb +28 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +65 -0
- data/proto_docs/google/api/resource.rb +283 -0
- data/proto_docs/google/cloud/shell/v1/cloudshell.rb +327 -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 +217 -0
@@ -0,0 +1,50 @@
|
|
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 Shell
|
23
|
+
module V1
|
24
|
+
module CloudShellService
|
25
|
+
# Path helper methods for the CloudShellService API.
|
26
|
+
module Paths
|
27
|
+
##
|
28
|
+
# Create a fully-qualified Environment resource string.
|
29
|
+
#
|
30
|
+
# The resource will be in the following format:
|
31
|
+
#
|
32
|
+
# `users/{user}/environments/{environment}`
|
33
|
+
#
|
34
|
+
# @param user [String]
|
35
|
+
# @param environment [String]
|
36
|
+
#
|
37
|
+
# @return [::String]
|
38
|
+
def environment_path user:, environment:
|
39
|
+
raise ::ArgumentError, "user cannot contain /" if user.to_s.include? "/"
|
40
|
+
|
41
|
+
"users/#{user}/environments/#{environment}"
|
42
|
+
end
|
43
|
+
|
44
|
+
extend self
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
@@ -0,0 +1,125 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# source: google/cloud/shell/v1/cloudshell.proto
|
3
|
+
|
4
|
+
require 'google/protobuf'
|
5
|
+
|
6
|
+
require 'google/api/annotations_pb'
|
7
|
+
require 'google/api/client_pb'
|
8
|
+
require 'google/api/field_behavior_pb'
|
9
|
+
require 'google/api/resource_pb'
|
10
|
+
require 'google/longrunning/operations_pb'
|
11
|
+
require 'google/protobuf/field_mask_pb'
|
12
|
+
require 'google/protobuf/timestamp_pb'
|
13
|
+
Google::Protobuf::DescriptorPool.generated_pool.build do
|
14
|
+
add_file("google/cloud/shell/v1/cloudshell.proto", :syntax => :proto3) do
|
15
|
+
add_message "google.cloud.shell.v1.Environment" do
|
16
|
+
optional :name, :string, 1
|
17
|
+
optional :id, :string, 2
|
18
|
+
optional :docker_image, :string, 3
|
19
|
+
optional :state, :enum, 4, "google.cloud.shell.v1.Environment.State"
|
20
|
+
optional :web_host, :string, 12
|
21
|
+
optional :ssh_username, :string, 5
|
22
|
+
optional :ssh_host, :string, 6
|
23
|
+
optional :ssh_port, :int32, 7
|
24
|
+
repeated :public_keys, :string, 8
|
25
|
+
end
|
26
|
+
add_enum "google.cloud.shell.v1.Environment.State" do
|
27
|
+
value :STATE_UNSPECIFIED, 0
|
28
|
+
value :SUSPENDED, 1
|
29
|
+
value :PENDING, 2
|
30
|
+
value :RUNNING, 3
|
31
|
+
value :DELETING, 4
|
32
|
+
end
|
33
|
+
add_message "google.cloud.shell.v1.GetEnvironmentRequest" do
|
34
|
+
optional :name, :string, 1
|
35
|
+
end
|
36
|
+
add_message "google.cloud.shell.v1.CreateEnvironmentMetadata" do
|
37
|
+
end
|
38
|
+
add_message "google.cloud.shell.v1.DeleteEnvironmentMetadata" do
|
39
|
+
end
|
40
|
+
add_message "google.cloud.shell.v1.StartEnvironmentRequest" do
|
41
|
+
optional :name, :string, 1
|
42
|
+
optional :access_token, :string, 2
|
43
|
+
repeated :public_keys, :string, 3
|
44
|
+
end
|
45
|
+
add_message "google.cloud.shell.v1.AuthorizeEnvironmentRequest" do
|
46
|
+
optional :name, :string, 1
|
47
|
+
optional :access_token, :string, 2
|
48
|
+
optional :id_token, :string, 4
|
49
|
+
optional :expire_time, :message, 3, "google.protobuf.Timestamp"
|
50
|
+
end
|
51
|
+
add_message "google.cloud.shell.v1.AuthorizeEnvironmentResponse" do
|
52
|
+
end
|
53
|
+
add_message "google.cloud.shell.v1.AuthorizeEnvironmentMetadata" do
|
54
|
+
end
|
55
|
+
add_message "google.cloud.shell.v1.StartEnvironmentMetadata" do
|
56
|
+
optional :state, :enum, 1, "google.cloud.shell.v1.StartEnvironmentMetadata.State"
|
57
|
+
end
|
58
|
+
add_enum "google.cloud.shell.v1.StartEnvironmentMetadata.State" do
|
59
|
+
value :STATE_UNSPECIFIED, 0
|
60
|
+
value :STARTING, 1
|
61
|
+
value :UNARCHIVING_DISK, 2
|
62
|
+
value :AWAITING_COMPUTE_RESOURCES, 4
|
63
|
+
value :FINISHED, 3
|
64
|
+
end
|
65
|
+
add_message "google.cloud.shell.v1.StartEnvironmentResponse" do
|
66
|
+
optional :environment, :message, 1, "google.cloud.shell.v1.Environment"
|
67
|
+
end
|
68
|
+
add_message "google.cloud.shell.v1.AddPublicKeyRequest" do
|
69
|
+
optional :environment, :string, 1
|
70
|
+
optional :key, :string, 2
|
71
|
+
end
|
72
|
+
add_message "google.cloud.shell.v1.AddPublicKeyResponse" do
|
73
|
+
optional :key, :string, 1
|
74
|
+
end
|
75
|
+
add_message "google.cloud.shell.v1.AddPublicKeyMetadata" do
|
76
|
+
end
|
77
|
+
add_message "google.cloud.shell.v1.RemovePublicKeyRequest" do
|
78
|
+
optional :environment, :string, 1
|
79
|
+
optional :key, :string, 2
|
80
|
+
end
|
81
|
+
add_message "google.cloud.shell.v1.RemovePublicKeyResponse" do
|
82
|
+
end
|
83
|
+
add_message "google.cloud.shell.v1.RemovePublicKeyMetadata" do
|
84
|
+
end
|
85
|
+
add_message "google.cloud.shell.v1.CloudShellErrorDetails" do
|
86
|
+
optional :code, :enum, 1, "google.cloud.shell.v1.CloudShellErrorDetails.CloudShellErrorCode"
|
87
|
+
end
|
88
|
+
add_enum "google.cloud.shell.v1.CloudShellErrorDetails.CloudShellErrorCode" do
|
89
|
+
value :CLOUD_SHELL_ERROR_CODE_UNSPECIFIED, 0
|
90
|
+
value :IMAGE_UNAVAILABLE, 1
|
91
|
+
value :CLOUD_SHELL_DISABLED, 2
|
92
|
+
value :TOS_VIOLATION, 4
|
93
|
+
value :QUOTA_EXCEEDED, 5
|
94
|
+
end
|
95
|
+
end
|
96
|
+
end
|
97
|
+
|
98
|
+
module Google
|
99
|
+
module Cloud
|
100
|
+
module Shell
|
101
|
+
module V1
|
102
|
+
Environment = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.Environment").msgclass
|
103
|
+
Environment::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.Environment.State").enummodule
|
104
|
+
GetEnvironmentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.GetEnvironmentRequest").msgclass
|
105
|
+
CreateEnvironmentMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.CreateEnvironmentMetadata").msgclass
|
106
|
+
DeleteEnvironmentMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.DeleteEnvironmentMetadata").msgclass
|
107
|
+
StartEnvironmentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.StartEnvironmentRequest").msgclass
|
108
|
+
AuthorizeEnvironmentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.AuthorizeEnvironmentRequest").msgclass
|
109
|
+
AuthorizeEnvironmentResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.AuthorizeEnvironmentResponse").msgclass
|
110
|
+
AuthorizeEnvironmentMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.AuthorizeEnvironmentMetadata").msgclass
|
111
|
+
StartEnvironmentMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.StartEnvironmentMetadata").msgclass
|
112
|
+
StartEnvironmentMetadata::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.StartEnvironmentMetadata.State").enummodule
|
113
|
+
StartEnvironmentResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.StartEnvironmentResponse").msgclass
|
114
|
+
AddPublicKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.AddPublicKeyRequest").msgclass
|
115
|
+
AddPublicKeyResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.AddPublicKeyResponse").msgclass
|
116
|
+
AddPublicKeyMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.AddPublicKeyMetadata").msgclass
|
117
|
+
RemovePublicKeyRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.RemovePublicKeyRequest").msgclass
|
118
|
+
RemovePublicKeyResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.RemovePublicKeyResponse").msgclass
|
119
|
+
RemovePublicKeyMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.RemovePublicKeyMetadata").msgclass
|
120
|
+
CloudShellErrorDetails = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.CloudShellErrorDetails").msgclass
|
121
|
+
CloudShellErrorDetails::CloudShellErrorCode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.shell.v1.CloudShellErrorDetails.CloudShellErrorCode").enummodule
|
122
|
+
end
|
123
|
+
end
|
124
|
+
end
|
125
|
+
end
|
@@ -0,0 +1,72 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# Source: google/cloud/shell/v1/cloudshell.proto for package 'google.cloud.shell.v1'
|
3
|
+
# Original file comments:
|
4
|
+
# Copyright 2021 Google LLC
|
5
|
+
#
|
6
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
7
|
+
# you may not use this file except in compliance with the License.
|
8
|
+
# You may obtain a copy of the License at
|
9
|
+
#
|
10
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
11
|
+
#
|
12
|
+
# Unless required by applicable law or agreed to in writing, software
|
13
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
14
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
15
|
+
# See the License for the specific language governing permissions and
|
16
|
+
# limitations under the License.
|
17
|
+
#
|
18
|
+
|
19
|
+
require 'grpc'
|
20
|
+
require 'google/cloud/shell/v1/cloudshell_pb'
|
21
|
+
|
22
|
+
module Google
|
23
|
+
module Cloud
|
24
|
+
module Shell
|
25
|
+
module V1
|
26
|
+
module CloudShellService
|
27
|
+
# API for interacting with Google Cloud Shell. Each user of Cloud Shell has at
|
28
|
+
# least one environment, which has the ID "default". Environment consists of a
|
29
|
+
# Docker image defining what is installed on the environment and a home
|
30
|
+
# directory containing the user's data that will remain across sessions.
|
31
|
+
# Clients use this API to start and fetch information about their environment,
|
32
|
+
# which can then be used to connect to that environment via a separate SSH
|
33
|
+
# client.
|
34
|
+
class Service
|
35
|
+
|
36
|
+
include GRPC::GenericService
|
37
|
+
|
38
|
+
self.marshal_class_method = :encode
|
39
|
+
self.unmarshal_class_method = :decode
|
40
|
+
self.service_name = 'google.cloud.shell.v1.CloudShellService'
|
41
|
+
|
42
|
+
# Gets an environment. Returns NOT_FOUND if the environment does not exist.
|
43
|
+
rpc :GetEnvironment, ::Google::Cloud::Shell::V1::GetEnvironmentRequest, ::Google::Cloud::Shell::V1::Environment
|
44
|
+
# Starts an existing environment, allowing clients to connect to it. The
|
45
|
+
# returned operation will contain an instance of StartEnvironmentMetadata in
|
46
|
+
# its metadata field. Users can wait for the environment to start by polling
|
47
|
+
# this operation via GetOperation. Once the environment has finished starting
|
48
|
+
# and is ready to accept connections, the operation will contain a
|
49
|
+
# StartEnvironmentResponse in its response field.
|
50
|
+
rpc :StartEnvironment, ::Google::Cloud::Shell::V1::StartEnvironmentRequest, ::Google::Longrunning::Operation
|
51
|
+
# Sends OAuth credentials to a running environment on behalf of a user. When
|
52
|
+
# this completes, the environment will be authorized to run various Google
|
53
|
+
# Cloud command line tools without requiring the user to manually
|
54
|
+
# authenticate.
|
55
|
+
rpc :AuthorizeEnvironment, ::Google::Cloud::Shell::V1::AuthorizeEnvironmentRequest, ::Google::Longrunning::Operation
|
56
|
+
# Adds a public SSH key to an environment, allowing clients with the
|
57
|
+
# corresponding private key to connect to that environment via SSH. If a key
|
58
|
+
# with the same content already exists, this will error with ALREADY_EXISTS.
|
59
|
+
rpc :AddPublicKey, ::Google::Cloud::Shell::V1::AddPublicKeyRequest, ::Google::Longrunning::Operation
|
60
|
+
# Removes a public SSH key from an environment. Clients will no longer be
|
61
|
+
# able to connect to the environment using the corresponding private key.
|
62
|
+
# If a key with the same content is not present, this will error with
|
63
|
+
# NOT_FOUND.
|
64
|
+
rpc :RemovePublicKey, ::Google::Cloud::Shell::V1::RemovePublicKeyRequest, ::Google::Longrunning::Operation
|
65
|
+
end
|
66
|
+
|
67
|
+
Stub = Service.rpc_stub_class
|
68
|
+
end
|
69
|
+
end
|
70
|
+
end
|
71
|
+
end
|
72
|
+
end
|
@@ -0,0 +1,28 @@
|
|
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 Shell
|
23
|
+
module V1
|
24
|
+
VERSION = "0.1.0"
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
@@ -0,0 +1,65 @@
|
|
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
|
+
# An indicator of the behavior of a given field (for example, that a field
|
23
|
+
# is required in requests, or given as output but ignored as input).
|
24
|
+
# This **does not** change the behavior in protocol buffers itself; it only
|
25
|
+
# denotes the behavior and may affect how API tooling handles the field.
|
26
|
+
#
|
27
|
+
# Note: This enum **may** receive new values in the future.
|
28
|
+
module FieldBehavior
|
29
|
+
# Conventional default for enums. Do not use this.
|
30
|
+
FIELD_BEHAVIOR_UNSPECIFIED = 0
|
31
|
+
|
32
|
+
# Specifically denotes a field as optional.
|
33
|
+
# While all fields in protocol buffers are optional, this may be specified
|
34
|
+
# for emphasis if appropriate.
|
35
|
+
OPTIONAL = 1
|
36
|
+
|
37
|
+
# Denotes a field as required.
|
38
|
+
# This indicates that the field **must** be provided as part of the request,
|
39
|
+
# and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
|
40
|
+
REQUIRED = 2
|
41
|
+
|
42
|
+
# Denotes a field as output only.
|
43
|
+
# This indicates that the field is provided in responses, but including the
|
44
|
+
# field in a request does nothing (the server *must* ignore it and
|
45
|
+
# *must not* throw an error as a result of the field's presence).
|
46
|
+
OUTPUT_ONLY = 3
|
47
|
+
|
48
|
+
# Denotes a field as input only.
|
49
|
+
# This indicates that the field is provided in requests, and the
|
50
|
+
# corresponding field is not included in output.
|
51
|
+
INPUT_ONLY = 4
|
52
|
+
|
53
|
+
# Denotes a field as immutable.
|
54
|
+
# This indicates that the field may be set once in a request to create a
|
55
|
+
# resource, but may not be changed thereafter.
|
56
|
+
IMMUTABLE = 5
|
57
|
+
|
58
|
+
# Denotes that a (repeated) field is an unordered list.
|
59
|
+
# This indicates that the service may provide the elements of the list
|
60
|
+
# in any arbitrary order, rather than the order the user originally
|
61
|
+
# provided. Additionally, the list's order may or may not be stable.
|
62
|
+
UNORDERED_LIST = 6
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
@@ -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
|