google-cloud-beyond_corp-client_gateways-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 +149 -0
- data/LICENSE.md +201 -0
- data/README.md +144 -0
- data/lib/google/cloud/beyond_corp/client_gateways/v1/client_gateways_service/client.rb +789 -0
- data/lib/google/cloud/beyond_corp/client_gateways/v1/client_gateways_service/credentials.rb +49 -0
- data/lib/google/cloud/beyond_corp/client_gateways/v1/client_gateways_service/operations.rb +772 -0
- data/lib/google/cloud/beyond_corp/client_gateways/v1/client_gateways_service/paths.rb +71 -0
- data/lib/google/cloud/beyond_corp/client_gateways/v1/client_gateways_service.rb +62 -0
- data/lib/google/cloud/beyond_corp/client_gateways/v1/version.rb +30 -0
- data/lib/google/cloud/beyond_corp/client_gateways/v1.rb +42 -0
- data/lib/google/cloud/beyondcorp/clientgateways/v1/client_gateways_service_pb.rb +88 -0
- data/lib/google/cloud/beyondcorp/clientgateways/v1/client_gateways_service_services_pb.rb +63 -0
- data/lib/google-cloud-beyond_corp-client_gateways-v1.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +71 -0
- data/proto_docs/google/api/resource.rb +222 -0
- data/proto_docs/google/cloud/beyondcorp/clientgateways/v1/client_gateways_service.rb +221 -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 +34 -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
- data/proto_docs/google/type/expr.rb +75 -0
- metadata +260 -0
@@ -0,0 +1,71 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 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 BeyondCorp
|
23
|
+
module ClientGateways
|
24
|
+
module V1
|
25
|
+
module ClientGatewaysService
|
26
|
+
# Path helper methods for the ClientGatewaysService API.
|
27
|
+
module Paths
|
28
|
+
##
|
29
|
+
# Create a fully-qualified ClientGateway resource string.
|
30
|
+
#
|
31
|
+
# The resource will be in the following format:
|
32
|
+
#
|
33
|
+
# `projects/{project}/locations/{location}/clientGateways/{client_gateway}`
|
34
|
+
#
|
35
|
+
# @param project [String]
|
36
|
+
# @param location [String]
|
37
|
+
# @param client_gateway [String]
|
38
|
+
#
|
39
|
+
# @return [::String]
|
40
|
+
def client_gateway_path project:, location:, client_gateway:
|
41
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
42
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
43
|
+
|
44
|
+
"projects/#{project}/locations/#{location}/clientGateways/#{client_gateway}"
|
45
|
+
end
|
46
|
+
|
47
|
+
##
|
48
|
+
# Create a fully-qualified Location resource string.
|
49
|
+
#
|
50
|
+
# The resource will be in the following format:
|
51
|
+
#
|
52
|
+
# `projects/{project}/locations/{location}`
|
53
|
+
#
|
54
|
+
# @param project [String]
|
55
|
+
# @param location [String]
|
56
|
+
#
|
57
|
+
# @return [::String]
|
58
|
+
def location_path project:, location:
|
59
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
60
|
+
|
61
|
+
"projects/#{project}/locations/#{location}"
|
62
|
+
end
|
63
|
+
|
64
|
+
extend self
|
65
|
+
end
|
66
|
+
end
|
67
|
+
end
|
68
|
+
end
|
69
|
+
end
|
70
|
+
end
|
71
|
+
end
|
@@ -0,0 +1,62 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 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
|
+
require "gapic/common"
|
20
|
+
require "gapic/config"
|
21
|
+
require "gapic/config/method"
|
22
|
+
|
23
|
+
require "google/cloud/beyond_corp/client_gateways/v1/version"
|
24
|
+
|
25
|
+
require "google/cloud/beyond_corp/client_gateways/v1/client_gateways_service/credentials"
|
26
|
+
require "google/cloud/beyond_corp/client_gateways/v1/client_gateways_service/paths"
|
27
|
+
require "google/cloud/beyond_corp/client_gateways/v1/client_gateways_service/operations"
|
28
|
+
require "google/cloud/beyond_corp/client_gateways/v1/client_gateways_service/client"
|
29
|
+
|
30
|
+
module Google
|
31
|
+
module Cloud
|
32
|
+
module BeyondCorp
|
33
|
+
module ClientGateways
|
34
|
+
module V1
|
35
|
+
##
|
36
|
+
# ## API Overview
|
37
|
+
#
|
38
|
+
# The `beyondcorp.googleapis.com` service implements the Google Cloud
|
39
|
+
# BeyondCorp API.
|
40
|
+
#
|
41
|
+
# ## Data Model
|
42
|
+
#
|
43
|
+
# The ClientGatewaysService exposes the following resources:
|
44
|
+
#
|
45
|
+
# * Client Gateways, named as follows:
|
46
|
+
# `projects/{project_id}/locations/{location_id}/clientGateways/{client_gateway_id}`.
|
47
|
+
#
|
48
|
+
# To load this service and instantiate a client:
|
49
|
+
#
|
50
|
+
# require "google/cloud/beyond_corp/client_gateways/v1/client_gateways_service"
|
51
|
+
# client = ::Google::Cloud::BeyondCorp::ClientGateways::V1::ClientGatewaysService::Client.new
|
52
|
+
#
|
53
|
+
module ClientGatewaysService
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
helper_path = ::File.join __dir__, "client_gateways_service", "helpers.rb"
|
62
|
+
require "google/cloud/beyond_corp/client_gateways/v1/client_gateways_service/helpers" if ::File.file? helper_path
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 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 BeyondCorp
|
23
|
+
module ClientGateways
|
24
|
+
module V1
|
25
|
+
VERSION = "0.1.0"
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
@@ -0,0 +1,42 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 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
|
+
require "google/cloud/beyond_corp/client_gateways/v1/client_gateways_service"
|
20
|
+
require "google/cloud/beyond_corp/client_gateways/v1/version"
|
21
|
+
|
22
|
+
module Google
|
23
|
+
module Cloud
|
24
|
+
module BeyondCorp
|
25
|
+
module ClientGateways
|
26
|
+
##
|
27
|
+
# To load this package, including all its services, and instantiate a client:
|
28
|
+
#
|
29
|
+
# @example
|
30
|
+
#
|
31
|
+
# require "google/cloud/beyond_corp/client_gateways/v1"
|
32
|
+
# client = ::Google::Cloud::BeyondCorp::ClientGateways::V1::ClientGatewaysService::Client.new
|
33
|
+
#
|
34
|
+
module V1
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
helper_path = ::File.join __dir__, "v1", "_helpers.rb"
|
42
|
+
require "google/cloud/beyond_corp/client_gateways/v1/_helpers" if ::File.file? helper_path
|
@@ -0,0 +1,88 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# source: google/cloud/beyondcorp/clientgateways/v1/client_gateways_service.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/timestamp_pb'
|
12
|
+
|
13
|
+
Google::Protobuf::DescriptorPool.generated_pool.build do
|
14
|
+
add_file("google/cloud/beyondcorp/clientgateways/v1/client_gateways_service.proto", :syntax => :proto3) do
|
15
|
+
add_message "google.cloud.beyondcorp.clientgateways.v1.ClientGateway" do
|
16
|
+
optional :name, :string, 1
|
17
|
+
optional :create_time, :message, 2, "google.protobuf.Timestamp"
|
18
|
+
optional :update_time, :message, 3, "google.protobuf.Timestamp"
|
19
|
+
optional :state, :enum, 4, "google.cloud.beyondcorp.clientgateways.v1.ClientGateway.State"
|
20
|
+
optional :id, :string, 5
|
21
|
+
optional :client_connector_service, :string, 6
|
22
|
+
end
|
23
|
+
add_enum "google.cloud.beyondcorp.clientgateways.v1.ClientGateway.State" do
|
24
|
+
value :STATE_UNSPECIFIED, 0
|
25
|
+
value :CREATING, 1
|
26
|
+
value :UPDATING, 2
|
27
|
+
value :DELETING, 3
|
28
|
+
value :RUNNING, 4
|
29
|
+
value :DOWN, 5
|
30
|
+
value :ERROR, 6
|
31
|
+
end
|
32
|
+
add_message "google.cloud.beyondcorp.clientgateways.v1.ListClientGatewaysRequest" do
|
33
|
+
optional :parent, :string, 1
|
34
|
+
optional :page_size, :int32, 2
|
35
|
+
optional :page_token, :string, 3
|
36
|
+
optional :filter, :string, 4
|
37
|
+
optional :order_by, :string, 5
|
38
|
+
end
|
39
|
+
add_message "google.cloud.beyondcorp.clientgateways.v1.ListClientGatewaysResponse" do
|
40
|
+
repeated :client_gateways, :message, 1, "google.cloud.beyondcorp.clientgateways.v1.ClientGateway"
|
41
|
+
optional :next_page_token, :string, 2
|
42
|
+
repeated :unreachable, :string, 3
|
43
|
+
end
|
44
|
+
add_message "google.cloud.beyondcorp.clientgateways.v1.GetClientGatewayRequest" do
|
45
|
+
optional :name, :string, 1
|
46
|
+
end
|
47
|
+
add_message "google.cloud.beyondcorp.clientgateways.v1.CreateClientGatewayRequest" do
|
48
|
+
optional :parent, :string, 1
|
49
|
+
optional :client_gateway_id, :string, 2
|
50
|
+
optional :client_gateway, :message, 3, "google.cloud.beyondcorp.clientgateways.v1.ClientGateway"
|
51
|
+
optional :request_id, :string, 4
|
52
|
+
optional :validate_only, :bool, 5
|
53
|
+
end
|
54
|
+
add_message "google.cloud.beyondcorp.clientgateways.v1.DeleteClientGatewayRequest" do
|
55
|
+
optional :name, :string, 1
|
56
|
+
optional :request_id, :string, 2
|
57
|
+
optional :validate_only, :bool, 3
|
58
|
+
end
|
59
|
+
add_message "google.cloud.beyondcorp.clientgateways.v1.ClientGatewayOperationMetadata" do
|
60
|
+
optional :create_time, :message, 1, "google.protobuf.Timestamp"
|
61
|
+
optional :end_time, :message, 2, "google.protobuf.Timestamp"
|
62
|
+
optional :target, :string, 3
|
63
|
+
optional :verb, :string, 4
|
64
|
+
optional :status_message, :string, 5
|
65
|
+
optional :requested_cancellation, :bool, 6
|
66
|
+
optional :api_version, :string, 7
|
67
|
+
end
|
68
|
+
end
|
69
|
+
end
|
70
|
+
|
71
|
+
module Google
|
72
|
+
module Cloud
|
73
|
+
module BeyondCorp
|
74
|
+
module ClientGateways
|
75
|
+
module V1
|
76
|
+
ClientGateway = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.beyondcorp.clientgateways.v1.ClientGateway").msgclass
|
77
|
+
ClientGateway::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.beyondcorp.clientgateways.v1.ClientGateway.State").enummodule
|
78
|
+
ListClientGatewaysRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.beyondcorp.clientgateways.v1.ListClientGatewaysRequest").msgclass
|
79
|
+
ListClientGatewaysResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.beyondcorp.clientgateways.v1.ListClientGatewaysResponse").msgclass
|
80
|
+
GetClientGatewayRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.beyondcorp.clientgateways.v1.GetClientGatewayRequest").msgclass
|
81
|
+
CreateClientGatewayRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.beyondcorp.clientgateways.v1.CreateClientGatewayRequest").msgclass
|
82
|
+
DeleteClientGatewayRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.beyondcorp.clientgateways.v1.DeleteClientGatewayRequest").msgclass
|
83
|
+
ClientGatewayOperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.beyondcorp.clientgateways.v1.ClientGatewayOperationMetadata").msgclass
|
84
|
+
end
|
85
|
+
end
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end
|
@@ -0,0 +1,63 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# Source: google/cloud/beyondcorp/clientgateways/v1/client_gateways_service.proto for package 'Google.Cloud.BeyondCorp.ClientGateways.V1'
|
3
|
+
# Original file comments:
|
4
|
+
# Copyright 2022 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/beyondcorp/clientgateways/v1/client_gateways_service_pb'
|
21
|
+
|
22
|
+
module Google
|
23
|
+
module Cloud
|
24
|
+
module BeyondCorp
|
25
|
+
module ClientGateways
|
26
|
+
module V1
|
27
|
+
module ClientGatewaysService
|
28
|
+
# ## API Overview
|
29
|
+
#
|
30
|
+
# The `beyondcorp.googleapis.com` service implements the Google Cloud
|
31
|
+
# BeyondCorp API.
|
32
|
+
#
|
33
|
+
# ## Data Model
|
34
|
+
#
|
35
|
+
# The ClientGatewaysService exposes the following resources:
|
36
|
+
#
|
37
|
+
# * Client Gateways, named as follows:
|
38
|
+
# `projects/{project_id}/locations/{location_id}/clientGateways/{client_gateway_id}`.
|
39
|
+
class Service
|
40
|
+
|
41
|
+
include ::GRPC::GenericService
|
42
|
+
|
43
|
+
self.marshal_class_method = :encode
|
44
|
+
self.unmarshal_class_method = :decode
|
45
|
+
self.service_name = 'google.cloud.beyondcorp.clientgateways.v1.ClientGatewaysService'
|
46
|
+
|
47
|
+
# Lists ClientGateways in a given project and location.
|
48
|
+
rpc :ListClientGateways, ::Google::Cloud::BeyondCorp::ClientGateways::V1::ListClientGatewaysRequest, ::Google::Cloud::BeyondCorp::ClientGateways::V1::ListClientGatewaysResponse
|
49
|
+
# Gets details of a single ClientGateway.
|
50
|
+
rpc :GetClientGateway, ::Google::Cloud::BeyondCorp::ClientGateways::V1::GetClientGatewayRequest, ::Google::Cloud::BeyondCorp::ClientGateways::V1::ClientGateway
|
51
|
+
# Creates a new ClientGateway in a given project and location.
|
52
|
+
rpc :CreateClientGateway, ::Google::Cloud::BeyondCorp::ClientGateways::V1::CreateClientGatewayRequest, ::Google::Longrunning::Operation
|
53
|
+
# Deletes a single ClientGateway.
|
54
|
+
rpc :DeleteClientGateway, ::Google::Cloud::BeyondCorp::ClientGateways::V1::DeleteClientGatewayRequest, ::Google::Longrunning::Operation
|
55
|
+
end
|
56
|
+
|
57
|
+
Stub = Service.rpc_stub_class
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 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
|
+
# This gem does not autoload during Bundler.require. To load this gem,
|
20
|
+
# issue explicit require statements for the packages desired, e.g.:
|
21
|
+
# require "google/cloud/beyond_corp/client_gateways/v1"
|
@@ -0,0 +1,71 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 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
|
+
|
64
|
+
# Denotes that this field returns a non-empty default value if not set.
|
65
|
+
# This indicates that if the user provides the empty value in a request,
|
66
|
+
# a non-empty value will be returned. The user will not be aware of what
|
67
|
+
# non-empty value to expect.
|
68
|
+
NON_EMPTY_DEFAULT = 7
|
69
|
+
end
|
70
|
+
end
|
71
|
+
end
|
@@ -0,0 +1,222 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 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
|
+
# pattern: "projects/{project}/topics/{topic}"
|
37
|
+
# };
|
38
|
+
# }
|
39
|
+
#
|
40
|
+
# The ResourceDescriptor Yaml config will look like:
|
41
|
+
#
|
42
|
+
# resources:
|
43
|
+
# - type: "pubsub.googleapis.com/Topic"
|
44
|
+
# pattern: "projects/{project}/topics/{topic}"
|
45
|
+
#
|
46
|
+
# Sometimes, resources have multiple patterns, typically because they can
|
47
|
+
# live under multiple parents.
|
48
|
+
#
|
49
|
+
# Example:
|
50
|
+
#
|
51
|
+
# message LogEntry {
|
52
|
+
# option (google.api.resource) = {
|
53
|
+
# type: "logging.googleapis.com/LogEntry"
|
54
|
+
# pattern: "projects/{project}/logs/{log}"
|
55
|
+
# pattern: "folders/{folder}/logs/{log}"
|
56
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
57
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
58
|
+
# };
|
59
|
+
# }
|
60
|
+
#
|
61
|
+
# The ResourceDescriptor Yaml config will look like:
|
62
|
+
#
|
63
|
+
# resources:
|
64
|
+
# - type: 'logging.googleapis.com/LogEntry'
|
65
|
+
# pattern: "projects/{project}/logs/{log}"
|
66
|
+
# pattern: "folders/{folder}/logs/{log}"
|
67
|
+
# pattern: "organizations/{organization}/logs/{log}"
|
68
|
+
# pattern: "billingAccounts/{billing_account}/logs/{log}"
|
69
|
+
# @!attribute [rw] type
|
70
|
+
# @return [::String]
|
71
|
+
# The resource type. It must be in the format of
|
72
|
+
# \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
|
73
|
+
# singular and must not include version numbers.
|
74
|
+
#
|
75
|
+
# Example: `storage.googleapis.com/Bucket`
|
76
|
+
#
|
77
|
+
# The value of the resource_type_kind must follow the regular expression
|
78
|
+
# /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
|
79
|
+
# should use PascalCase (UpperCamelCase). The maximum number of
|
80
|
+
# characters allowed for the `resource_type_kind` is 100.
|
81
|
+
# @!attribute [rw] pattern
|
82
|
+
# @return [::Array<::String>]
|
83
|
+
# Optional. The relative resource name pattern associated with this resource
|
84
|
+
# type. The DNS prefix of the full resource name shouldn't be specified here.
|
85
|
+
#
|
86
|
+
# The path pattern must follow the syntax, which aligns with HTTP binding
|
87
|
+
# syntax:
|
88
|
+
#
|
89
|
+
# Template = Segment { "/" Segment } ;
|
90
|
+
# Segment = LITERAL | Variable ;
|
91
|
+
# Variable = "{" LITERAL "}" ;
|
92
|
+
#
|
93
|
+
# Examples:
|
94
|
+
#
|
95
|
+
# - "projects/\\{project}/topics/\\{topic}"
|
96
|
+
# - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
|
97
|
+
#
|
98
|
+
# The components in braces correspond to the IDs for each resource in the
|
99
|
+
# hierarchy. It is expected that, if multiple patterns are provided,
|
100
|
+
# the same component name (e.g. "project") refers to IDs of the same
|
101
|
+
# type of resource.
|
102
|
+
# @!attribute [rw] name_field
|
103
|
+
# @return [::String]
|
104
|
+
# Optional. The field on the resource that designates the resource name
|
105
|
+
# field. If omitted, this is assumed to be "name".
|
106
|
+
# @!attribute [rw] history
|
107
|
+
# @return [::Google::Api::ResourceDescriptor::History]
|
108
|
+
# Optional. The historical or future-looking state of the resource pattern.
|
109
|
+
#
|
110
|
+
# Example:
|
111
|
+
#
|
112
|
+
# // The InspectTemplate message originally only supported resource
|
113
|
+
# // names with organization, and project was added later.
|
114
|
+
# message InspectTemplate {
|
115
|
+
# option (google.api.resource) = {
|
116
|
+
# type: "dlp.googleapis.com/InspectTemplate"
|
117
|
+
# pattern:
|
118
|
+
# "organizations/{organization}/inspectTemplates/{inspect_template}"
|
119
|
+
# pattern: "projects/{project}/inspectTemplates/{inspect_template}"
|
120
|
+
# history: ORIGINALLY_SINGLE_PATTERN
|
121
|
+
# };
|
122
|
+
# }
|
123
|
+
# @!attribute [rw] plural
|
124
|
+
# @return [::String]
|
125
|
+
# The plural name used in the resource name and permission names, such as
|
126
|
+
# 'projects' for the resource name of 'projects/\\{project}' and the permission
|
127
|
+
# name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
|
128
|
+
# concept of the `plural` field in k8s CRD spec
|
129
|
+
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
130
|
+
#
|
131
|
+
# Note: The plural form is required even for singleton resources. See
|
132
|
+
# https://aip.dev/156
|
133
|
+
# @!attribute [rw] singular
|
134
|
+
# @return [::String]
|
135
|
+
# The same concept of the `singular` field in k8s CRD spec
|
136
|
+
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
137
|
+
# Such as "project" for the `resourcemanager.googleapis.com/Project` type.
|
138
|
+
# @!attribute [rw] style
|
139
|
+
# @return [::Array<::Google::Api::ResourceDescriptor::Style>]
|
140
|
+
# Style flag(s) for this resource.
|
141
|
+
# These indicate that a resource is expected to conform to a given
|
142
|
+
# style. See the specific style flags for additional information.
|
143
|
+
class ResourceDescriptor
|
144
|
+
include ::Google::Protobuf::MessageExts
|
145
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
146
|
+
|
147
|
+
# A description of the historical or future-looking state of the
|
148
|
+
# resource pattern.
|
149
|
+
module History
|
150
|
+
# The "unset" value.
|
151
|
+
HISTORY_UNSPECIFIED = 0
|
152
|
+
|
153
|
+
# The resource originally had one pattern and launched as such, and
|
154
|
+
# additional patterns were added later.
|
155
|
+
ORIGINALLY_SINGLE_PATTERN = 1
|
156
|
+
|
157
|
+
# The resource has one pattern, but the API owner expects to add more
|
158
|
+
# later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
|
159
|
+
# that from being necessary once there are multiple patterns.)
|
160
|
+
FUTURE_MULTI_PATTERN = 2
|
161
|
+
end
|
162
|
+
|
163
|
+
# A flag representing a specific style that a resource claims to conform to.
|
164
|
+
module Style
|
165
|
+
# The unspecified value. Do not use.
|
166
|
+
STYLE_UNSPECIFIED = 0
|
167
|
+
|
168
|
+
# This resource is intended to be "declarative-friendly".
|
169
|
+
#
|
170
|
+
# Declarative-friendly resources must be more strictly consistent, and
|
171
|
+
# setting this to true communicates to tools that this resource should
|
172
|
+
# adhere to declarative-friendly expectations.
|
173
|
+
#
|
174
|
+
# Note: This is used by the API linter (linter.aip.dev) to enable
|
175
|
+
# additional checks.
|
176
|
+
DECLARATIVE_FRIENDLY = 1
|
177
|
+
end
|
178
|
+
end
|
179
|
+
|
180
|
+
# Defines a proto annotation that describes a string field that refers to
|
181
|
+
# an API resource.
|
182
|
+
# @!attribute [rw] type
|
183
|
+
# @return [::String]
|
184
|
+
# The resource type that the annotated field references.
|
185
|
+
#
|
186
|
+
# Example:
|
187
|
+
#
|
188
|
+
# message Subscription {
|
189
|
+
# string topic = 2 [(google.api.resource_reference) = {
|
190
|
+
# type: "pubsub.googleapis.com/Topic"
|
191
|
+
# }];
|
192
|
+
# }
|
193
|
+
#
|
194
|
+
# Occasionally, a field may reference an arbitrary resource. In this case,
|
195
|
+
# APIs use the special value * in their resource reference.
|
196
|
+
#
|
197
|
+
# Example:
|
198
|
+
#
|
199
|
+
# message GetIamPolicyRequest {
|
200
|
+
# string resource = 2 [(google.api.resource_reference) = {
|
201
|
+
# type: "*"
|
202
|
+
# }];
|
203
|
+
# }
|
204
|
+
# @!attribute [rw] child_type
|
205
|
+
# @return [::String]
|
206
|
+
# The resource type of a child collection that the annotated field
|
207
|
+
# references. This is useful for annotating the `parent` field that
|
208
|
+
# doesn't have a fixed resource type.
|
209
|
+
#
|
210
|
+
# Example:
|
211
|
+
#
|
212
|
+
# message ListLogEntriesRequest {
|
213
|
+
# string parent = 1 [(google.api.resource_reference) = {
|
214
|
+
# child_type: "logging.googleapis.com/LogEntry"
|
215
|
+
# };
|
216
|
+
# }
|
217
|
+
class ResourceReference
|
218
|
+
include ::Google::Protobuf::MessageExts
|
219
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
220
|
+
end
|
221
|
+
end
|
222
|
+
end
|