google-cloud-monitoring-metrics_scope-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 +167 -0
- data/LICENSE.md +201 -0
- data/README.md +139 -0
- data/lib/google/cloud/monitoring/metrics_scope/v1/metrics_scopes/client.rb +627 -0
- data/lib/google/cloud/monitoring/metrics_scope/v1/metrics_scopes/credentials.rb +52 -0
- data/lib/google/cloud/monitoring/metrics_scope/v1/metrics_scopes/operations.rb +666 -0
- data/lib/google/cloud/monitoring/metrics_scope/v1/metrics_scopes/paths.rb +66 -0
- data/lib/google/cloud/monitoring/metrics_scope/v1/metrics_scopes.rb +53 -0
- data/lib/google/cloud/monitoring/metrics_scope/v1/version.rb +30 -0
- data/lib/google/cloud/monitoring/metrics_scope/v1.rb +40 -0
- data/lib/google/monitoring/metricsscope/v1/metrics_scope_pb.rb +35 -0
- data/lib/google/monitoring/metricsscope/v1/metrics_scopes_pb.rb +62 -0
- data/lib/google/monitoring/metricsscope/v1/metrics_scopes_services_pb.rb +57 -0
- data/lib/google-cloud-monitoring-metrics_scope-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 +283 -0
- data/proto_docs/google/longrunning/operations.rb +164 -0
- data/proto_docs/google/monitoring/metricsscope/v1/metrics_scope.rb +72 -0
- data/proto_docs/google/monitoring/metricsscope/v1/metrics_scopes.rb +127 -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/timestamp.rb +129 -0
- data/proto_docs/google/rpc/status.rb +46 -0
- metadata +219 -0
@@ -0,0 +1,66 @@
|
|
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 Monitoring
|
23
|
+
module MetricsScope
|
24
|
+
module V1
|
25
|
+
module MetricsScopes
|
26
|
+
# Path helper methods for the MetricsScopes API.
|
27
|
+
module Paths
|
28
|
+
##
|
29
|
+
# Create a fully-qualified MetricsScope resource string.
|
30
|
+
#
|
31
|
+
# The resource will be in the following format:
|
32
|
+
#
|
33
|
+
# `locations/global/metricsScope/{metrics_scope}`
|
34
|
+
#
|
35
|
+
# @param metrics_scope [String]
|
36
|
+
#
|
37
|
+
# @return [::String]
|
38
|
+
def metrics_scope_path metrics_scope:
|
39
|
+
"locations/global/metricsScope/#{metrics_scope}"
|
40
|
+
end
|
41
|
+
|
42
|
+
##
|
43
|
+
# Create a fully-qualified MonitoredProject resource string.
|
44
|
+
#
|
45
|
+
# The resource will be in the following format:
|
46
|
+
#
|
47
|
+
# `locations/global/metricsScopes/{metrics_scope}/projects/{project}`
|
48
|
+
#
|
49
|
+
# @param metrics_scope [String]
|
50
|
+
# @param project [String]
|
51
|
+
#
|
52
|
+
# @return [::String]
|
53
|
+
def monitored_project_path metrics_scope:, project:
|
54
|
+
raise ::ArgumentError, "metrics_scope cannot contain /" if metrics_scope.to_s.include? "/"
|
55
|
+
|
56
|
+
"locations/global/metricsScopes/#{metrics_scope}/projects/#{project}"
|
57
|
+
end
|
58
|
+
|
59
|
+
extend self
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|
@@ -0,0 +1,53 @@
|
|
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
|
+
require "gapic/common"
|
20
|
+
require "gapic/config"
|
21
|
+
require "gapic/config/method"
|
22
|
+
|
23
|
+
require "google/cloud/monitoring/metrics_scope/v1/version"
|
24
|
+
|
25
|
+
require "google/cloud/monitoring/metrics_scope/v1/metrics_scopes/credentials"
|
26
|
+
require "google/cloud/monitoring/metrics_scope/v1/metrics_scopes/paths"
|
27
|
+
require "google/cloud/monitoring/metrics_scope/v1/metrics_scopes/operations"
|
28
|
+
require "google/cloud/monitoring/metrics_scope/v1/metrics_scopes/client"
|
29
|
+
|
30
|
+
module Google
|
31
|
+
module Cloud
|
32
|
+
module Monitoring
|
33
|
+
module MetricsScope
|
34
|
+
module V1
|
35
|
+
##
|
36
|
+
# Manages Cloud Monitoring Metrics Scopes, and the monitoring of Google Cloud
|
37
|
+
# projects and AWS accounts.
|
38
|
+
#
|
39
|
+
# To load this service and instantiate a client:
|
40
|
+
#
|
41
|
+
# require "google/cloud/monitoring/metrics_scope/v1/metrics_scopes"
|
42
|
+
# client = ::Google::Cloud::Monitoring::MetricsScope::V1::MetricsScopes::Client.new
|
43
|
+
#
|
44
|
+
module MetricsScopes
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
helper_path = ::File.join __dir__, "metrics_scopes", "helpers.rb"
|
53
|
+
require "google/cloud/monitoring/metrics_scope/v1/metrics_scopes/helpers" if ::File.file? helper_path
|
@@ -0,0 +1,30 @@
|
|
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 Monitoring
|
23
|
+
module MetricsScope
|
24
|
+
module V1
|
25
|
+
VERSION = "0.1.0"
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
@@ -0,0 +1,40 @@
|
|
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
|
+
require "google/cloud/monitoring/metrics_scope/v1/metrics_scopes"
|
20
|
+
require "google/cloud/monitoring/metrics_scope/v1/version"
|
21
|
+
|
22
|
+
module Google
|
23
|
+
module Cloud
|
24
|
+
module Monitoring
|
25
|
+
module MetricsScope
|
26
|
+
##
|
27
|
+
# To load this package, including all its services, and instantiate a client:
|
28
|
+
#
|
29
|
+
# require "google/cloud/monitoring/metrics_scope/v1"
|
30
|
+
# client = ::Google::Cloud::Monitoring::MetricsScope::V1::MetricsScopes::Client.new
|
31
|
+
#
|
32
|
+
module V1
|
33
|
+
end
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
helper_path = ::File.join __dir__, "v1", "_helpers.rb"
|
40
|
+
require "google/cloud/monitoring/metrics_scope/v1/_helpers" if ::File.file? helper_path
|
@@ -0,0 +1,35 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# source: google/monitoring/metricsscope/v1/metrics_scope.proto
|
3
|
+
|
4
|
+
require 'google/protobuf'
|
5
|
+
|
6
|
+
require 'google/api/field_behavior_pb'
|
7
|
+
require 'google/api/resource_pb'
|
8
|
+
require 'google/protobuf/timestamp_pb'
|
9
|
+
Google::Protobuf::DescriptorPool.generated_pool.build do
|
10
|
+
add_file("google/monitoring/metricsscope/v1/metrics_scope.proto", :syntax => :proto3) do
|
11
|
+
add_message "google.monitoring.metricsscope.v1.MetricsScope" do
|
12
|
+
optional :name, :string, 1
|
13
|
+
optional :create_time, :message, 2, "google.protobuf.Timestamp"
|
14
|
+
optional :update_time, :message, 3, "google.protobuf.Timestamp"
|
15
|
+
repeated :monitored_projects, :message, 4, "google.monitoring.metricsscope.v1.MonitoredProject"
|
16
|
+
end
|
17
|
+
add_message "google.monitoring.metricsscope.v1.MonitoredProject" do
|
18
|
+
optional :name, :string, 1
|
19
|
+
optional :create_time, :message, 6, "google.protobuf.Timestamp"
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
module Google
|
25
|
+
module Cloud
|
26
|
+
module Monitoring
|
27
|
+
module MetricsScope
|
28
|
+
module V1
|
29
|
+
MetricsScope = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.metricsscope.v1.MetricsScope").msgclass
|
30
|
+
MonitoredProject = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.metricsscope.v1.MonitoredProject").msgclass
|
31
|
+
end
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
35
|
+
end
|
@@ -0,0 +1,62 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# source: google/monitoring/metricsscope/v1/metrics_scopes.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/monitoring/metricsscope/v1/metrics_scope_pb'
|
12
|
+
require 'google/protobuf/timestamp_pb'
|
13
|
+
Google::Protobuf::DescriptorPool.generated_pool.build do
|
14
|
+
add_file("google/monitoring/metricsscope/v1/metrics_scopes.proto", :syntax => :proto3) do
|
15
|
+
add_message "google.monitoring.metricsscope.v1.GetMetricsScopeRequest" do
|
16
|
+
optional :name, :string, 1
|
17
|
+
end
|
18
|
+
add_message "google.monitoring.metricsscope.v1.ListMetricsScopesByMonitoredProjectRequest" do
|
19
|
+
optional :monitored_resource_container, :string, 1
|
20
|
+
end
|
21
|
+
add_message "google.monitoring.metricsscope.v1.ListMetricsScopesByMonitoredProjectResponse" do
|
22
|
+
repeated :metrics_scopes, :message, 1, "google.monitoring.metricsscope.v1.MetricsScope"
|
23
|
+
end
|
24
|
+
add_message "google.monitoring.metricsscope.v1.CreateMonitoredProjectRequest" do
|
25
|
+
optional :parent, :string, 1
|
26
|
+
optional :monitored_project, :message, 2, "google.monitoring.metricsscope.v1.MonitoredProject"
|
27
|
+
end
|
28
|
+
add_message "google.monitoring.metricsscope.v1.DeleteMonitoredProjectRequest" do
|
29
|
+
optional :name, :string, 1
|
30
|
+
end
|
31
|
+
add_message "google.monitoring.metricsscope.v1.OperationMetadata" do
|
32
|
+
optional :state, :enum, 1, "google.monitoring.metricsscope.v1.OperationMetadata.State"
|
33
|
+
optional :create_time, :message, 5, "google.protobuf.Timestamp"
|
34
|
+
optional :update_time, :message, 6, "google.protobuf.Timestamp"
|
35
|
+
end
|
36
|
+
add_enum "google.monitoring.metricsscope.v1.OperationMetadata.State" do
|
37
|
+
value :STATE_UNSPECIFIED, 0
|
38
|
+
value :CREATED, 1
|
39
|
+
value :RUNNING, 2
|
40
|
+
value :DONE, 3
|
41
|
+
value :CANCELLED, 4
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
module Google
|
47
|
+
module Cloud
|
48
|
+
module Monitoring
|
49
|
+
module MetricsScope
|
50
|
+
module V1
|
51
|
+
GetMetricsScopeRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.metricsscope.v1.GetMetricsScopeRequest").msgclass
|
52
|
+
ListMetricsScopesByMonitoredProjectRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.metricsscope.v1.ListMetricsScopesByMonitoredProjectRequest").msgclass
|
53
|
+
ListMetricsScopesByMonitoredProjectResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.metricsscope.v1.ListMetricsScopesByMonitoredProjectResponse").msgclass
|
54
|
+
CreateMonitoredProjectRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.metricsscope.v1.CreateMonitoredProjectRequest").msgclass
|
55
|
+
DeleteMonitoredProjectRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.metricsscope.v1.DeleteMonitoredProjectRequest").msgclass
|
56
|
+
OperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.metricsscope.v1.OperationMetadata").msgclass
|
57
|
+
OperationMetadata::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.metricsscope.v1.OperationMetadata.State").enummodule
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
@@ -0,0 +1,57 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# Source: google/monitoring/metricsscope/v1/metrics_scopes.proto for package 'Google.Cloud.Monitoring.MetricsScope.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/monitoring/metricsscope/v1/metrics_scopes_pb'
|
21
|
+
|
22
|
+
module Google
|
23
|
+
module Cloud
|
24
|
+
module Monitoring
|
25
|
+
module MetricsScope
|
26
|
+
module V1
|
27
|
+
module MetricsScopes
|
28
|
+
# Manages Cloud Monitoring Metrics Scopes, and the monitoring of Google Cloud
|
29
|
+
# projects and AWS accounts.
|
30
|
+
class Service
|
31
|
+
|
32
|
+
include ::GRPC::GenericService
|
33
|
+
|
34
|
+
self.marshal_class_method = :encode
|
35
|
+
self.unmarshal_class_method = :decode
|
36
|
+
self.service_name = 'google.monitoring.metricsscope.v1.MetricsScopes'
|
37
|
+
|
38
|
+
# Returns a specific `Metrics Scope`.
|
39
|
+
rpc :GetMetricsScope, ::Google::Cloud::Monitoring::MetricsScope::V1::GetMetricsScopeRequest, ::Google::Cloud::Monitoring::MetricsScope::V1::MetricsScope
|
40
|
+
# Returns a list of every `Metrics Scope` that a specific `MonitoredProject`
|
41
|
+
# has been added to. The metrics scope representing the specified monitored
|
42
|
+
# project will always be the first entry in the response.
|
43
|
+
rpc :ListMetricsScopesByMonitoredProject, ::Google::Cloud::Monitoring::MetricsScope::V1::ListMetricsScopesByMonitoredProjectRequest, ::Google::Cloud::Monitoring::MetricsScope::V1::ListMetricsScopesByMonitoredProjectResponse
|
44
|
+
# Adds a `MonitoredProject` with the given project ID
|
45
|
+
# to the specified `Metrics Scope`.
|
46
|
+
rpc :CreateMonitoredProject, ::Google::Cloud::Monitoring::MetricsScope::V1::CreateMonitoredProjectRequest, ::Google::Longrunning::Operation
|
47
|
+
# Deletes a `MonitoredProject` from the specified `Metrics Scope`.
|
48
|
+
rpc :DeleteMonitoredProject, ::Google::Cloud::Monitoring::MetricsScope::V1::DeleteMonitoredProjectRequest, ::Google::Longrunning::Operation
|
49
|
+
end
|
50
|
+
|
51
|
+
Stub = Service.rpc_stub_class
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
@@ -0,0 +1,21 @@
|
|
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
|
+
# 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/monitoring/metrics_scope/v1"
|
@@ -0,0 +1,71 @@
|
|
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
|
+
|
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
|