google-cloud-profiler-v2 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 +203 -0
- data/README.md +139 -0
- data/lib/google-cloud-profiler-v2.rb +21 -0
- data/lib/google/cloud/profiler/v2.rb +38 -0
- data/lib/google/cloud/profiler/v2/profiler_service.rb +53 -0
- data/lib/google/cloud/profiler/v2/profiler_service/client.rb +566 -0
- data/lib/google/cloud/profiler/v2/profiler_service/credentials.rb +53 -0
- data/lib/google/cloud/profiler/v2/version.rb +28 -0
- data/lib/google/devtools/cloudprofiler/v2/profiler_pb.rb +64 -0
- data/lib/google/devtools/cloudprofiler/v2/profiler_services_pb.rb +71 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/resource.rb +283 -0
- data/proto_docs/google/devtools/cloudprofiler/v2/profiler.rb +192 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- metadata +205 -0
@@ -0,0 +1,192 @@
|
|
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 Profiler
|
23
|
+
module V2
|
24
|
+
# CreateProfileRequest describes a profile resource online creation request.
|
25
|
+
# The deployment field must be populated. The profile_type specifies the list
|
26
|
+
# of profile types supported by the agent. The creation call will hang until a
|
27
|
+
# profile of one of these types needs to be collected.
|
28
|
+
# @!attribute [rw] parent
|
29
|
+
# @return [::String]
|
30
|
+
# Parent project to create the profile in.
|
31
|
+
# @!attribute [rw] deployment
|
32
|
+
# @return [::Google::Cloud::Profiler::V2::Deployment]
|
33
|
+
# Deployment details.
|
34
|
+
# @!attribute [rw] profile_type
|
35
|
+
# @return [::Array<::Google::Cloud::Profiler::V2::ProfileType>]
|
36
|
+
# One or more profile types that the agent is capable of providing.
|
37
|
+
class CreateProfileRequest
|
38
|
+
include ::Google::Protobuf::MessageExts
|
39
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
40
|
+
end
|
41
|
+
|
42
|
+
# CreateOfflineProfileRequest describes a profile resource offline creation
|
43
|
+
# request. Profile field must be set.
|
44
|
+
# @!attribute [rw] parent
|
45
|
+
# @return [::String]
|
46
|
+
# Parent project to create the profile in.
|
47
|
+
# @!attribute [rw] profile
|
48
|
+
# @return [::Google::Cloud::Profiler::V2::Profile]
|
49
|
+
# Contents of the profile to create.
|
50
|
+
class CreateOfflineProfileRequest
|
51
|
+
include ::Google::Protobuf::MessageExts
|
52
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
53
|
+
end
|
54
|
+
|
55
|
+
# UpdateProfileRequest contains the profile to update.
|
56
|
+
# @!attribute [rw] profile
|
57
|
+
# @return [::Google::Cloud::Profiler::V2::Profile]
|
58
|
+
# Profile to update
|
59
|
+
# @!attribute [rw] update_mask
|
60
|
+
# @return [::Google::Protobuf::FieldMask]
|
61
|
+
# Field mask used to specify the fields to be overwritten. Currently only
|
62
|
+
# profile_bytes and labels fields are supported by UpdateProfile, so only
|
63
|
+
# those fields can be specified in the mask. When no mask is provided, all
|
64
|
+
# fields are overwritten.
|
65
|
+
class UpdateProfileRequest
|
66
|
+
include ::Google::Protobuf::MessageExts
|
67
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
68
|
+
end
|
69
|
+
|
70
|
+
# Profile resource.
|
71
|
+
# @!attribute [rw] name
|
72
|
+
# @return [::String]
|
73
|
+
# Output only. Opaque, server-assigned, unique ID for this profile.
|
74
|
+
# @!attribute [rw] profile_type
|
75
|
+
# @return [::Google::Cloud::Profiler::V2::ProfileType]
|
76
|
+
# Type of profile.
|
77
|
+
# For offline mode, this must be specified when creating the profile. For
|
78
|
+
# online mode it is assigned and returned by the server.
|
79
|
+
# @!attribute [rw] deployment
|
80
|
+
# @return [::Google::Cloud::Profiler::V2::Deployment]
|
81
|
+
# Deployment this profile corresponds to.
|
82
|
+
# @!attribute [rw] duration
|
83
|
+
# @return [::Google::Protobuf::Duration]
|
84
|
+
# Duration of the profiling session.
|
85
|
+
# Input (for the offline mode) or output (for the online mode).
|
86
|
+
# The field represents requested profiling duration. It may slightly differ
|
87
|
+
# from the effective profiling duration, which is recorded in the profile
|
88
|
+
# data, in case the profiling can't be stopped immediately (e.g. in case
|
89
|
+
# stopping the profiling is handled asynchronously).
|
90
|
+
# @!attribute [rw] profile_bytes
|
91
|
+
# @return [::String]
|
92
|
+
# Input only. Profile bytes, as a gzip compressed serialized proto, the
|
93
|
+
# format is https://github.com/google/pprof/blob/master/proto/profile.proto.
|
94
|
+
# @!attribute [rw] labels
|
95
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
96
|
+
# Input only. Labels associated to this specific profile. These labels will
|
97
|
+
# get merged with the deployment labels for the final data set. See
|
98
|
+
# documentation on deployment labels for validation rules and limits.
|
99
|
+
class Profile
|
100
|
+
include ::Google::Protobuf::MessageExts
|
101
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
102
|
+
|
103
|
+
# @!attribute [rw] key
|
104
|
+
# @return [::String]
|
105
|
+
# @!attribute [rw] value
|
106
|
+
# @return [::String]
|
107
|
+
class LabelsEntry
|
108
|
+
include ::Google::Protobuf::MessageExts
|
109
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
110
|
+
end
|
111
|
+
end
|
112
|
+
|
113
|
+
# Deployment contains the deployment identification information.
|
114
|
+
# @!attribute [rw] project_id
|
115
|
+
# @return [::String]
|
116
|
+
# Project ID is the ID of a cloud project.
|
117
|
+
# Validation regex: `^[a-z][-a-z0-9:.]{4,61}[a-z0-9]$`.
|
118
|
+
# @!attribute [rw] target
|
119
|
+
# @return [::String]
|
120
|
+
# Target is the service name used to group related deployments:
|
121
|
+
# * Service name for GAE Flex / Standard.
|
122
|
+
# * Cluster and container name for GKE.
|
123
|
+
# * User-specified string for direct GCE profiling (e.g. Java).
|
124
|
+
# * Job name for Dataflow.
|
125
|
+
# Validation regex: `^[a-z]([-a-z0-9_.]{0,253}[a-z0-9])?$`.
|
126
|
+
# @!attribute [rw] labels
|
127
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
128
|
+
# Labels identify the deployment within the user universe and same target.
|
129
|
+
# Validation regex for label names: `^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$`.
|
130
|
+
# Value for an individual label must be <= 512 bytes, the total
|
131
|
+
# size of all label names and values must be <= 1024 bytes.
|
132
|
+
#
|
133
|
+
# Label named "language" can be used to record the programming language of
|
134
|
+
# the profiled deployment. The standard choices for the value include "java",
|
135
|
+
# "go", "python", "ruby", "nodejs", "php", "dotnet".
|
136
|
+
#
|
137
|
+
# For deployments running on Google Cloud Platform, "zone" or "region" label
|
138
|
+
# should be present describing the deployment location. An example of a zone
|
139
|
+
# is "us-central1-a", an example of a region is "us-central1" or
|
140
|
+
# "us-central".
|
141
|
+
class Deployment
|
142
|
+
include ::Google::Protobuf::MessageExts
|
143
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
144
|
+
|
145
|
+
# @!attribute [rw] key
|
146
|
+
# @return [::String]
|
147
|
+
# @!attribute [rw] value
|
148
|
+
# @return [::String]
|
149
|
+
class LabelsEntry
|
150
|
+
include ::Google::Protobuf::MessageExts
|
151
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
152
|
+
end
|
153
|
+
end
|
154
|
+
|
155
|
+
# ProfileType is type of profiling data.
|
156
|
+
# NOTE: the enumeration member names are used (in lowercase) as unique string
|
157
|
+
# identifiers of profile types, so they must not be renamed.
|
158
|
+
module ProfileType
|
159
|
+
# Unspecified profile type.
|
160
|
+
PROFILE_TYPE_UNSPECIFIED = 0
|
161
|
+
|
162
|
+
# Thread CPU time sampling.
|
163
|
+
CPU = 1
|
164
|
+
|
165
|
+
# Wallclock time sampling. More expensive as stops all threads.
|
166
|
+
WALL = 2
|
167
|
+
|
168
|
+
# In-use heap profile. Represents a snapshot of the allocations that are
|
169
|
+
# live at the time of the profiling.
|
170
|
+
HEAP = 3
|
171
|
+
|
172
|
+
# Single-shot collection of all thread stacks.
|
173
|
+
THREADS = 4
|
174
|
+
|
175
|
+
# Synchronization contention profile.
|
176
|
+
CONTENTION = 5
|
177
|
+
|
178
|
+
# Peak heap profile.
|
179
|
+
PEAK_HEAP = 6
|
180
|
+
|
181
|
+
# Heap allocation profile. It represents the aggregation of all allocations
|
182
|
+
# made over the duration of the profile. All allocations are included,
|
183
|
+
# including those that might have been freed by the end of the profiling
|
184
|
+
# interval. The profile is in particular useful for garbage collecting
|
185
|
+
# languages to understand which parts of the code create most of the garbage
|
186
|
+
# collection pressure to see if those can be optimized.
|
187
|
+
HEAP_ALLOC = 7
|
188
|
+
end
|
189
|
+
end
|
190
|
+
end
|
191
|
+
end
|
192
|
+
end
|
@@ -0,0 +1,98 @@
|
|
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 Protobuf
|
22
|
+
# A Duration represents a signed, fixed-length span of time represented
|
23
|
+
# as a count of seconds and fractions of seconds at nanosecond
|
24
|
+
# resolution. It is independent of any calendar and concepts like "day"
|
25
|
+
# or "month". It is related to Timestamp in that the difference between
|
26
|
+
# two Timestamp values is a Duration and it can be added or subtracted
|
27
|
+
# from a Timestamp. Range is approximately +-10,000 years.
|
28
|
+
#
|
29
|
+
# # Examples
|
30
|
+
#
|
31
|
+
# Example 1: Compute Duration from two Timestamps in pseudo code.
|
32
|
+
#
|
33
|
+
# Timestamp start = ...;
|
34
|
+
# Timestamp end = ...;
|
35
|
+
# Duration duration = ...;
|
36
|
+
#
|
37
|
+
# duration.seconds = end.seconds - start.seconds;
|
38
|
+
# duration.nanos = end.nanos - start.nanos;
|
39
|
+
#
|
40
|
+
# if (duration.seconds < 0 && duration.nanos > 0) {
|
41
|
+
# duration.seconds += 1;
|
42
|
+
# duration.nanos -= 1000000000;
|
43
|
+
# } else if (duration.seconds > 0 && duration.nanos < 0) {
|
44
|
+
# duration.seconds -= 1;
|
45
|
+
# duration.nanos += 1000000000;
|
46
|
+
# }
|
47
|
+
#
|
48
|
+
# Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
|
49
|
+
#
|
50
|
+
# Timestamp start = ...;
|
51
|
+
# Duration duration = ...;
|
52
|
+
# Timestamp end = ...;
|
53
|
+
#
|
54
|
+
# end.seconds = start.seconds + duration.seconds;
|
55
|
+
# end.nanos = start.nanos + duration.nanos;
|
56
|
+
#
|
57
|
+
# if (end.nanos < 0) {
|
58
|
+
# end.seconds -= 1;
|
59
|
+
# end.nanos += 1000000000;
|
60
|
+
# } else if (end.nanos >= 1000000000) {
|
61
|
+
# end.seconds += 1;
|
62
|
+
# end.nanos -= 1000000000;
|
63
|
+
# }
|
64
|
+
#
|
65
|
+
# Example 3: Compute Duration from datetime.timedelta in Python.
|
66
|
+
#
|
67
|
+
# td = datetime.timedelta(days=3, minutes=10)
|
68
|
+
# duration = Duration()
|
69
|
+
# duration.FromTimedelta(td)
|
70
|
+
#
|
71
|
+
# # JSON Mapping
|
72
|
+
#
|
73
|
+
# In JSON format, the Duration type is encoded as a string rather than an
|
74
|
+
# object, where the string ends in the suffix "s" (indicating seconds) and
|
75
|
+
# is preceded by the number of seconds, with nanoseconds expressed as
|
76
|
+
# fractional seconds. For example, 3 seconds with 0 nanoseconds should be
|
77
|
+
# encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
|
78
|
+
# be expressed in JSON format as "3.000000001s", and 3 seconds and 1
|
79
|
+
# microsecond should be expressed in JSON format as "3.000001s".
|
80
|
+
# @!attribute [rw] seconds
|
81
|
+
# @return [::Integer]
|
82
|
+
# Signed seconds of the span of time. Must be from -315,576,000,000
|
83
|
+
# to +315,576,000,000 inclusive. Note: these bounds are computed from:
|
84
|
+
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
|
85
|
+
# @!attribute [rw] nanos
|
86
|
+
# @return [::Integer]
|
87
|
+
# Signed fractions of a second at nanosecond resolution of the span
|
88
|
+
# of time. Durations less than one second are represented with a 0
|
89
|
+
# `seconds` field and a positive or negative `nanos` field. For durations
|
90
|
+
# of one second or more, a non-zero value for the `nanos` field must be
|
91
|
+
# of the same sign as the `seconds` field. Must be from -999,999,999
|
92
|
+
# to +999,999,999 inclusive.
|
93
|
+
class Duration
|
94
|
+
include ::Google::Protobuf::MessageExts
|
95
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
96
|
+
end
|
97
|
+
end
|
98
|
+
end
|
@@ -0,0 +1,229 @@
|
|
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 Protobuf
|
22
|
+
# `FieldMask` represents a set of symbolic field paths, for example:
|
23
|
+
#
|
24
|
+
# paths: "f.a"
|
25
|
+
# paths: "f.b.d"
|
26
|
+
#
|
27
|
+
# Here `f` represents a field in some root message, `a` and `b`
|
28
|
+
# fields in the message found in `f`, and `d` a field found in the
|
29
|
+
# message in `f.b`.
|
30
|
+
#
|
31
|
+
# Field masks are used to specify a subset of fields that should be
|
32
|
+
# returned by a get operation or modified by an update operation.
|
33
|
+
# Field masks also have a custom JSON encoding (see below).
|
34
|
+
#
|
35
|
+
# # Field Masks in Projections
|
36
|
+
#
|
37
|
+
# When used in the context of a projection, a response message or
|
38
|
+
# sub-message is filtered by the API to only contain those fields as
|
39
|
+
# specified in the mask. For example, if the mask in the previous
|
40
|
+
# example is applied to a response message as follows:
|
41
|
+
#
|
42
|
+
# f {
|
43
|
+
# a : 22
|
44
|
+
# b {
|
45
|
+
# d : 1
|
46
|
+
# x : 2
|
47
|
+
# }
|
48
|
+
# y : 13
|
49
|
+
# }
|
50
|
+
# z: 8
|
51
|
+
#
|
52
|
+
# The result will not contain specific values for fields x,y and z
|
53
|
+
# (their value will be set to the default, and omitted in proto text
|
54
|
+
# output):
|
55
|
+
#
|
56
|
+
#
|
57
|
+
# f {
|
58
|
+
# a : 22
|
59
|
+
# b {
|
60
|
+
# d : 1
|
61
|
+
# }
|
62
|
+
# }
|
63
|
+
#
|
64
|
+
# A repeated field is not allowed except at the last position of a
|
65
|
+
# paths string.
|
66
|
+
#
|
67
|
+
# If a FieldMask object is not present in a get operation, the
|
68
|
+
# operation applies to all fields (as if a FieldMask of all fields
|
69
|
+
# had been specified).
|
70
|
+
#
|
71
|
+
# Note that a field mask does not necessarily apply to the
|
72
|
+
# top-level response message. In case of a REST get operation, the
|
73
|
+
# field mask applies directly to the response, but in case of a REST
|
74
|
+
# list operation, the mask instead applies to each individual message
|
75
|
+
# in the returned resource list. In case of a REST custom method,
|
76
|
+
# other definitions may be used. Where the mask applies will be
|
77
|
+
# clearly documented together with its declaration in the API. In
|
78
|
+
# any case, the effect on the returned resource/resources is required
|
79
|
+
# behavior for APIs.
|
80
|
+
#
|
81
|
+
# # Field Masks in Update Operations
|
82
|
+
#
|
83
|
+
# A field mask in update operations specifies which fields of the
|
84
|
+
# targeted resource are going to be updated. The API is required
|
85
|
+
# to only change the values of the fields as specified in the mask
|
86
|
+
# and leave the others untouched. If a resource is passed in to
|
87
|
+
# describe the updated values, the API ignores the values of all
|
88
|
+
# fields not covered by the mask.
|
89
|
+
#
|
90
|
+
# If a repeated field is specified for an update operation, new values will
|
91
|
+
# be appended to the existing repeated field in the target resource. Note that
|
92
|
+
# a repeated field is only allowed in the last position of a `paths` string.
|
93
|
+
#
|
94
|
+
# If a sub-message is specified in the last position of the field mask for an
|
95
|
+
# update operation, then new value will be merged into the existing sub-message
|
96
|
+
# in the target resource.
|
97
|
+
#
|
98
|
+
# For example, given the target message:
|
99
|
+
#
|
100
|
+
# f {
|
101
|
+
# b {
|
102
|
+
# d: 1
|
103
|
+
# x: 2
|
104
|
+
# }
|
105
|
+
# c: [1]
|
106
|
+
# }
|
107
|
+
#
|
108
|
+
# And an update message:
|
109
|
+
#
|
110
|
+
# f {
|
111
|
+
# b {
|
112
|
+
# d: 10
|
113
|
+
# }
|
114
|
+
# c: [2]
|
115
|
+
# }
|
116
|
+
#
|
117
|
+
# then if the field mask is:
|
118
|
+
#
|
119
|
+
# paths: ["f.b", "f.c"]
|
120
|
+
#
|
121
|
+
# then the result will be:
|
122
|
+
#
|
123
|
+
# f {
|
124
|
+
# b {
|
125
|
+
# d: 10
|
126
|
+
# x: 2
|
127
|
+
# }
|
128
|
+
# c: [1, 2]
|
129
|
+
# }
|
130
|
+
#
|
131
|
+
# An implementation may provide options to override this default behavior for
|
132
|
+
# repeated and message fields.
|
133
|
+
#
|
134
|
+
# In order to reset a field's value to the default, the field must
|
135
|
+
# be in the mask and set to the default value in the provided resource.
|
136
|
+
# Hence, in order to reset all fields of a resource, provide a default
|
137
|
+
# instance of the resource and set all fields in the mask, or do
|
138
|
+
# not provide a mask as described below.
|
139
|
+
#
|
140
|
+
# If a field mask is not present on update, the operation applies to
|
141
|
+
# all fields (as if a field mask of all fields has been specified).
|
142
|
+
# Note that in the presence of schema evolution, this may mean that
|
143
|
+
# fields the client does not know and has therefore not filled into
|
144
|
+
# the request will be reset to their default. If this is unwanted
|
145
|
+
# behavior, a specific service may require a client to always specify
|
146
|
+
# a field mask, producing an error if not.
|
147
|
+
#
|
148
|
+
# As with get operations, the location of the resource which
|
149
|
+
# describes the updated values in the request message depends on the
|
150
|
+
# operation kind. In any case, the effect of the field mask is
|
151
|
+
# required to be honored by the API.
|
152
|
+
#
|
153
|
+
# ## Considerations for HTTP REST
|
154
|
+
#
|
155
|
+
# The HTTP kind of an update operation which uses a field mask must
|
156
|
+
# be set to PATCH instead of PUT in order to satisfy HTTP semantics
|
157
|
+
# (PUT must only be used for full updates).
|
158
|
+
#
|
159
|
+
# # JSON Encoding of Field Masks
|
160
|
+
#
|
161
|
+
# In JSON, a field mask is encoded as a single string where paths are
|
162
|
+
# separated by a comma. Fields name in each path are converted
|
163
|
+
# to/from lower-camel naming conventions.
|
164
|
+
#
|
165
|
+
# As an example, consider the following message declarations:
|
166
|
+
#
|
167
|
+
# message Profile {
|
168
|
+
# User user = 1;
|
169
|
+
# Photo photo = 2;
|
170
|
+
# }
|
171
|
+
# message User {
|
172
|
+
# string display_name = 1;
|
173
|
+
# string address = 2;
|
174
|
+
# }
|
175
|
+
#
|
176
|
+
# In proto a field mask for `Profile` may look as such:
|
177
|
+
#
|
178
|
+
# mask {
|
179
|
+
# paths: "user.display_name"
|
180
|
+
# paths: "photo"
|
181
|
+
# }
|
182
|
+
#
|
183
|
+
# In JSON, the same mask is represented as below:
|
184
|
+
#
|
185
|
+
# {
|
186
|
+
# mask: "user.displayName,photo"
|
187
|
+
# }
|
188
|
+
#
|
189
|
+
# # Field Masks and Oneof Fields
|
190
|
+
#
|
191
|
+
# Field masks treat fields in oneofs just as regular fields. Consider the
|
192
|
+
# following message:
|
193
|
+
#
|
194
|
+
# message SampleMessage {
|
195
|
+
# oneof test_oneof {
|
196
|
+
# string name = 4;
|
197
|
+
# SubMessage sub_message = 9;
|
198
|
+
# }
|
199
|
+
# }
|
200
|
+
#
|
201
|
+
# The field mask can be:
|
202
|
+
#
|
203
|
+
# mask {
|
204
|
+
# paths: "name"
|
205
|
+
# }
|
206
|
+
#
|
207
|
+
# Or:
|
208
|
+
#
|
209
|
+
# mask {
|
210
|
+
# paths: "sub_message"
|
211
|
+
# }
|
212
|
+
#
|
213
|
+
# Note that oneof type names ("test_oneof" in this case) cannot be used in
|
214
|
+
# paths.
|
215
|
+
#
|
216
|
+
# ## Field Mask Verification
|
217
|
+
#
|
218
|
+
# The implementation of any API method which has a FieldMask type field in the
|
219
|
+
# request should verify the included field paths, and return an
|
220
|
+
# `INVALID_ARGUMENT` error if any path is unmappable.
|
221
|
+
# @!attribute [rw] paths
|
222
|
+
# @return [::Array<::String>]
|
223
|
+
# The set of field mask paths.
|
224
|
+
class FieldMask
|
225
|
+
include ::Google::Protobuf::MessageExts
|
226
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
227
|
+
end
|
228
|
+
end
|
229
|
+
end
|