google-cloud-service_directory-v1beta1 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 +24 -0
- data/lib/google-cloud-service_directory-v1beta1.rb +1 -0
- data/lib/google/cloud/common_resources_pb.rb +15 -0
- data/lib/google/cloud/service_directory/v1beta1.rb +20 -0
- data/lib/google/cloud/service_directory/v1beta1/lookup_service.rb +20 -0
- data/lib/google/cloud/service_directory/v1beta1/lookup_service/client.rb +406 -0
- data/lib/google/cloud/service_directory/v1beta1/lookup_service/credentials.rb +52 -0
- data/lib/google/cloud/service_directory/v1beta1/lookup_service/paths.rb +52 -0
- data/lib/google/cloud/service_directory/v1beta1/registration_service.rb +20 -0
- data/lib/google/cloud/service_directory/v1beta1/registration_service/client.rb +1666 -0
- data/lib/google/cloud/service_directory/v1beta1/registration_service/credentials.rb +52 -0
- data/lib/google/cloud/service_directory/v1beta1/registration_service/paths.rb +111 -0
- data/lib/google/cloud/service_directory/v1beta1/version.rb +28 -0
- data/lib/google/cloud/servicedirectory/v1beta1/endpoint_pb.rb +28 -0
- data/lib/google/cloud/servicedirectory/v1beta1/lookup_service_pb.rb +33 -0
- data/lib/google/cloud/servicedirectory/v1beta1/lookup_service_services_pb.rb +47 -0
- data/lib/google/cloud/servicedirectory/v1beta1/namespace_pb.rb +26 -0
- data/lib/google/cloud/servicedirectory/v1beta1/registration_service_pb.rb +125 -0
- data/lib/google/cloud/servicedirectory/v1beta1/registration_service_services_pb.rb +95 -0
- data/lib/google/cloud/servicedirectory/v1beta1/service_pb.rb +28 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +59 -0
- data/proto_docs/google/api/resource.rb +247 -0
- data/proto_docs/google/cloud/servicedirectory/v1beta1/endpoint.rb +66 -0
- data/proto_docs/google/cloud/servicedirectory/v1beta1/lookup_service.rb +69 -0
- data/proto_docs/google/cloud/servicedirectory/v1beta1/namespace.rb +52 -0
- data/proto_docs/google/cloud/servicedirectory/v1beta1/registration_service.rb +367 -0
- data/proto_docs/google/cloud/servicedirectory/v1beta1/service.rb +58 -0
- data/proto_docs/google/iam/v1/iam_policy.rb +79 -0
- data/proto_docs/google/iam/v1/policy.rb +156 -0
- data/proto_docs/google/protobuf/empty.rb +36 -0
- data/proto_docs/google/protobuf/field_mask.rb +237 -0
- metadata +205 -0
@@ -0,0 +1,58 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 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 ServiceDirectory
|
23
|
+
module V1beta1
|
24
|
+
# An individual service. A service contains a name and optional metadata.
|
25
|
+
# A service must exist before
|
26
|
+
# {Google::Cloud::ServiceDirectory::V1beta1::Endpoint endpoints} can be
|
27
|
+
# added to it.
|
28
|
+
# @!attribute [rw] name
|
29
|
+
# @return [String]
|
30
|
+
# Immutable. The resource name for the service in the format
|
31
|
+
# 'projects/*/locations/*/namespaces/*/services/*'.
|
32
|
+
# @!attribute [rw] metadata
|
33
|
+
# @return [Google::Protobuf::Map{String => String}]
|
34
|
+
# Optional. Metadata for the service. This data can be consumed by service
|
35
|
+
# clients. The entire metadata dictionary may contain up to 2000 characters,
|
36
|
+
# spread across all key-value pairs. Metadata that goes beyond any these
|
37
|
+
# limits will be rejected.
|
38
|
+
# @!attribute [r] endpoints
|
39
|
+
# @return [Array<Google::Cloud::ServiceDirectory::V1beta1::Endpoint>]
|
40
|
+
# Output only. Endpoints associated with this service. Returned on LookupService.Resolve.
|
41
|
+
# Control plane clients should use RegistrationService.ListEndpoints.
|
42
|
+
class Service
|
43
|
+
include Google::Protobuf::MessageExts
|
44
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
45
|
+
|
46
|
+
# @!attribute [rw] key
|
47
|
+
# @return [String]
|
48
|
+
# @!attribute [rw] value
|
49
|
+
# @return [String]
|
50
|
+
class MetadataEntry
|
51
|
+
include Google::Protobuf::MessageExts
|
52
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
@@ -0,0 +1,79 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 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 Iam
|
22
|
+
module V1
|
23
|
+
# Request message for `SetIamPolicy` method.
|
24
|
+
# @!attribute [rw] resource
|
25
|
+
# @return [String]
|
26
|
+
# REQUIRED: The resource for which the policy is being specified.
|
27
|
+
# `resource` is usually specified as a path. For example, a Project
|
28
|
+
# resource is specified as `projects/{project}`.
|
29
|
+
# @!attribute [rw] policy
|
30
|
+
# @return [Google::Iam::V1::Policy]
|
31
|
+
# REQUIRED: The complete policy to be applied to the `resource`. The size of
|
32
|
+
# the policy is limited to a few 10s of KB. An empty policy is a
|
33
|
+
# valid policy but certain Cloud Platform services (such as Projects)
|
34
|
+
# might reject them.
|
35
|
+
class SetIamPolicyRequest
|
36
|
+
include Google::Protobuf::MessageExts
|
37
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
38
|
+
end
|
39
|
+
|
40
|
+
# Request message for `GetIamPolicy` method.
|
41
|
+
# @!attribute [rw] resource
|
42
|
+
# @return [String]
|
43
|
+
# REQUIRED: The resource for which the policy is being requested.
|
44
|
+
# `resource` is usually specified as a path. For example, a Project
|
45
|
+
# resource is specified as `projects/{project}`.
|
46
|
+
class GetIamPolicyRequest
|
47
|
+
include Google::Protobuf::MessageExts
|
48
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
49
|
+
end
|
50
|
+
|
51
|
+
# Request message for `TestIamPermissions` method.
|
52
|
+
# @!attribute [rw] resource
|
53
|
+
# @return [String]
|
54
|
+
# REQUIRED: The resource for which the policy detail is being requested.
|
55
|
+
# `resource` is usually specified as a path. For example, a Project
|
56
|
+
# resource is specified as `projects/{project}`.
|
57
|
+
# @!attribute [rw] permissions
|
58
|
+
# @return [Array<String>]
|
59
|
+
# The set of permissions to check for the `resource`. Permissions with
|
60
|
+
# wildcards (such as '*' or 'storage.*') are not allowed. For more
|
61
|
+
# information see
|
62
|
+
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
|
63
|
+
class TestIamPermissionsRequest
|
64
|
+
include Google::Protobuf::MessageExts
|
65
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
66
|
+
end
|
67
|
+
|
68
|
+
# Response message for `TestIamPermissions` method.
|
69
|
+
# @!attribute [rw] permissions
|
70
|
+
# @return [Array<String>]
|
71
|
+
# A subset of `TestPermissionsRequest.permissions` that the caller is
|
72
|
+
# allowed.
|
73
|
+
class TestIamPermissionsResponse
|
74
|
+
include Google::Protobuf::MessageExts
|
75
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
76
|
+
end
|
77
|
+
end
|
78
|
+
end
|
79
|
+
end
|
@@ -0,0 +1,156 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 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 Iam
|
22
|
+
module V1
|
23
|
+
# Defines an Identity and Access Management (IAM) policy. It is used to
|
24
|
+
# specify access control policies for Cloud Platform resources.
|
25
|
+
#
|
26
|
+
#
|
27
|
+
# A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
|
28
|
+
# `members` to a `role`, where the members can be user accounts, Google groups,
|
29
|
+
# Google domains, and service accounts. A `role` is a named list of permissions
|
30
|
+
# defined by IAM.
|
31
|
+
#
|
32
|
+
# **Example**
|
33
|
+
#
|
34
|
+
# {
|
35
|
+
# "bindings": [
|
36
|
+
# {
|
37
|
+
# "role": "roles/owner",
|
38
|
+
# "members": [
|
39
|
+
# "user:mike@example.com",
|
40
|
+
# "group:admins@example.com",
|
41
|
+
# "domain:google.com",
|
42
|
+
# "serviceAccount:my-other-app@appspot.gserviceaccount.com",
|
43
|
+
# ]
|
44
|
+
# },
|
45
|
+
# {
|
46
|
+
# "role": "roles/viewer",
|
47
|
+
# "members": ["user:sean@example.com"]
|
48
|
+
# }
|
49
|
+
# ]
|
50
|
+
# }
|
51
|
+
#
|
52
|
+
# For a description of IAM and its features, see the
|
53
|
+
# [IAM developer's guide](https://cloud.google.com/iam).
|
54
|
+
# @!attribute [rw] version
|
55
|
+
# @return [Integer]
|
56
|
+
# Version of the `Policy`. The default version is 0.
|
57
|
+
# @!attribute [rw] bindings
|
58
|
+
# @return [Array<Google::Iam::V1::Binding>]
|
59
|
+
# Associates a list of `members` to a `role`.
|
60
|
+
# Multiple `bindings` must not be specified for the same `role`.
|
61
|
+
# `bindings` with no members will result in an error.
|
62
|
+
# @!attribute [rw] etag
|
63
|
+
# @return [String]
|
64
|
+
# `etag` is used for optimistic concurrency control as a way to help
|
65
|
+
# prevent simultaneous updates of a policy from overwriting each other.
|
66
|
+
# It is strongly suggested that systems make use of the `etag` in the
|
67
|
+
# read-modify-write cycle to perform policy updates in order to avoid race
|
68
|
+
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
|
69
|
+
# systems are expected to put that etag in the request to `setIamPolicy` to
|
70
|
+
# ensure that their change will be applied to the same version of the policy.
|
71
|
+
#
|
72
|
+
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
|
73
|
+
# policy is overwritten blindly.
|
74
|
+
class Policy
|
75
|
+
include Google::Protobuf::MessageExts
|
76
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
77
|
+
end
|
78
|
+
|
79
|
+
# Associates `members` with a `role`.
|
80
|
+
# @!attribute [rw] role
|
81
|
+
# @return [String]
|
82
|
+
# Role that is assigned to `members`.
|
83
|
+
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
|
84
|
+
# Required
|
85
|
+
# @!attribute [rw] members
|
86
|
+
# @return [Array<String>]
|
87
|
+
# Specifies the identities requesting access for a Cloud Platform resource.
|
88
|
+
# `members` can have the following values:
|
89
|
+
#
|
90
|
+
# * `allUsers`: A special identifier that represents anyone who is
|
91
|
+
# on the internet; with or without a Google account.
|
92
|
+
#
|
93
|
+
# * `allAuthenticatedUsers`: A special identifier that represents anyone
|
94
|
+
# who is authenticated with a Google account or a service account.
|
95
|
+
#
|
96
|
+
# * `user:{emailid}`: An email address that represents a specific Google
|
97
|
+
# account. For example, `alice@gmail.com` or `joe@example.com`.
|
98
|
+
#
|
99
|
+
#
|
100
|
+
# * `serviceAccount:{emailid}`: An email address that represents a service
|
101
|
+
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
|
102
|
+
#
|
103
|
+
# * `group:{emailid}`: An email address that represents a Google group.
|
104
|
+
# For example, `admins@example.com`.
|
105
|
+
#
|
106
|
+
# * `domain:{domain}`: A Google Apps domain name that represents all the
|
107
|
+
# users of that domain. For example, `google.com` or `example.com`.
|
108
|
+
class Binding
|
109
|
+
include Google::Protobuf::MessageExts
|
110
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
111
|
+
end
|
112
|
+
|
113
|
+
# The difference delta between two policies.
|
114
|
+
# @!attribute [rw] binding_deltas
|
115
|
+
# @return [Array<Google::Iam::V1::BindingDelta>]
|
116
|
+
# The delta for Bindings between two policies.
|
117
|
+
class PolicyDelta
|
118
|
+
include Google::Protobuf::MessageExts
|
119
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
120
|
+
end
|
121
|
+
|
122
|
+
# One delta entry for Binding. Each individual change (only one member in each
|
123
|
+
# entry) to a binding will be a separate entry.
|
124
|
+
# @!attribute [rw] action
|
125
|
+
# @return [Google::Iam::V1::BindingDelta::Action]
|
126
|
+
# The action that was performed on a Binding.
|
127
|
+
# Required
|
128
|
+
# @!attribute [rw] role
|
129
|
+
# @return [String]
|
130
|
+
# Role that is assigned to `members`.
|
131
|
+
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
|
132
|
+
# Required
|
133
|
+
# @!attribute [rw] member
|
134
|
+
# @return [String]
|
135
|
+
# A single identity requesting access for a Cloud Platform resource.
|
136
|
+
# Follows the same format of Binding.members.
|
137
|
+
# Required
|
138
|
+
class BindingDelta
|
139
|
+
include Google::Protobuf::MessageExts
|
140
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
141
|
+
|
142
|
+
# The type of action performed on a Binding in a policy.
|
143
|
+
module Action
|
144
|
+
# Unspecified.
|
145
|
+
ACTION_UNSPECIFIED = 0
|
146
|
+
|
147
|
+
# Addition of a Binding.
|
148
|
+
ADD = 1
|
149
|
+
|
150
|
+
# Removal of a Binding.
|
151
|
+
REMOVE = 2
|
152
|
+
end
|
153
|
+
end
|
154
|
+
end
|
155
|
+
end
|
156
|
+
end
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 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 generic empty message that you can re-use to avoid defining duplicated
|
23
|
+
# empty messages in your APIs. A typical example is to use it as the request
|
24
|
+
# or the response type of an API method. For instance:
|
25
|
+
#
|
26
|
+
# service Foo {
|
27
|
+
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
28
|
+
# }
|
29
|
+
#
|
30
|
+
# The JSON representation for `Empty` is empty JSON object `{}`.
|
31
|
+
class Empty
|
32
|
+
include Google::Protobuf::MessageExts
|
33
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
@@ -0,0 +1,237 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 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, the existing
|
91
|
+
# repeated values in the target resource will be overwritten by the new values.
|
92
|
+
# Note that a repeated field is only allowed in the last position of a `paths`
|
93
|
+
# string.
|
94
|
+
#
|
95
|
+
# If a sub-message is specified in the last position of the field mask for an
|
96
|
+
# update operation, then the existing sub-message in the target resource is
|
97
|
+
# overwritten. Given the target message:
|
98
|
+
#
|
99
|
+
# f {
|
100
|
+
# b {
|
101
|
+
# d : 1
|
102
|
+
# x : 2
|
103
|
+
# }
|
104
|
+
# c : 1
|
105
|
+
# }
|
106
|
+
#
|
107
|
+
# And an update message:
|
108
|
+
#
|
109
|
+
# f {
|
110
|
+
# b {
|
111
|
+
# d : 10
|
112
|
+
# }
|
113
|
+
# }
|
114
|
+
#
|
115
|
+
# then if the field mask is:
|
116
|
+
#
|
117
|
+
# paths: "f.b"
|
118
|
+
#
|
119
|
+
# then the result will be:
|
120
|
+
#
|
121
|
+
# f {
|
122
|
+
# b {
|
123
|
+
# d : 10
|
124
|
+
# }
|
125
|
+
# c : 1
|
126
|
+
# }
|
127
|
+
#
|
128
|
+
# However, if the update mask was:
|
129
|
+
#
|
130
|
+
# paths: "f.b.d"
|
131
|
+
#
|
132
|
+
# then the result would be:
|
133
|
+
#
|
134
|
+
# f {
|
135
|
+
# b {
|
136
|
+
# d : 10
|
137
|
+
# x : 2
|
138
|
+
# }
|
139
|
+
# c : 1
|
140
|
+
# }
|
141
|
+
#
|
142
|
+
# In order to reset a field's value to the default, the field must
|
143
|
+
# be in the mask and set to the default value in the provided resource.
|
144
|
+
# Hence, in order to reset all fields of a resource, provide a default
|
145
|
+
# instance of the resource and set all fields in the mask, or do
|
146
|
+
# not provide a mask as described below.
|
147
|
+
#
|
148
|
+
# If a field mask is not present on update, the operation applies to
|
149
|
+
# all fields (as if a field mask of all fields has been specified).
|
150
|
+
# Note that in the presence of schema evolution, this may mean that
|
151
|
+
# fields the client does not know and has therefore not filled into
|
152
|
+
# the request will be reset to their default. If this is unwanted
|
153
|
+
# behavior, a specific service may require a client to always specify
|
154
|
+
# a field mask, producing an error if not.
|
155
|
+
#
|
156
|
+
# As with get operations, the location of the resource which
|
157
|
+
# describes the updated values in the request message depends on the
|
158
|
+
# operation kind. In any case, the effect of the field mask is
|
159
|
+
# required to be honored by the API.
|
160
|
+
#
|
161
|
+
# ## Considerations for HTTP REST
|
162
|
+
#
|
163
|
+
# The HTTP kind of an update operation which uses a field mask must
|
164
|
+
# be set to PATCH instead of PUT in order to satisfy HTTP semantics
|
165
|
+
# (PUT must only be used for full updates).
|
166
|
+
#
|
167
|
+
# # JSON Encoding of Field Masks
|
168
|
+
#
|
169
|
+
# In JSON, a field mask is encoded as a single string where paths are
|
170
|
+
# separated by a comma. Fields name in each path are converted
|
171
|
+
# to/from lower-camel naming conventions.
|
172
|
+
#
|
173
|
+
# As an example, consider the following message declarations:
|
174
|
+
#
|
175
|
+
# message Profile {
|
176
|
+
# User user = 1;
|
177
|
+
# Photo photo = 2;
|
178
|
+
# }
|
179
|
+
# message User {
|
180
|
+
# string display_name = 1;
|
181
|
+
# string address = 2;
|
182
|
+
# }
|
183
|
+
#
|
184
|
+
# In proto a field mask for `Profile` may look as such:
|
185
|
+
#
|
186
|
+
# mask {
|
187
|
+
# paths: "user.display_name"
|
188
|
+
# paths: "photo"
|
189
|
+
# }
|
190
|
+
#
|
191
|
+
# In JSON, the same mask is represented as below:
|
192
|
+
#
|
193
|
+
# {
|
194
|
+
# mask: "user.displayName,photo"
|
195
|
+
# }
|
196
|
+
#
|
197
|
+
# # Field Masks and Oneof Fields
|
198
|
+
#
|
199
|
+
# Field masks treat fields in oneofs just as regular fields. Consider the
|
200
|
+
# following message:
|
201
|
+
#
|
202
|
+
# message SampleMessage {
|
203
|
+
# oneof test_oneof {
|
204
|
+
# string name = 4;
|
205
|
+
# SubMessage sub_message = 9;
|
206
|
+
# }
|
207
|
+
# }
|
208
|
+
#
|
209
|
+
# The field mask can be:
|
210
|
+
#
|
211
|
+
# mask {
|
212
|
+
# paths: "name"
|
213
|
+
# }
|
214
|
+
#
|
215
|
+
# Or:
|
216
|
+
#
|
217
|
+
# mask {
|
218
|
+
# paths: "sub_message"
|
219
|
+
# }
|
220
|
+
#
|
221
|
+
# Note that oneof type names ("test_oneof" in this case) cannot be used in
|
222
|
+
# paths.
|
223
|
+
#
|
224
|
+
# ## Field Mask Verification
|
225
|
+
#
|
226
|
+
# The implementation of any API method which has a FieldMask type field in the
|
227
|
+
# request should verify the included field paths, and return an
|
228
|
+
# `INVALID_ARGUMENT` error if any path is duplicated or unmappable.
|
229
|
+
# @!attribute [rw] paths
|
230
|
+
# @return [Array<String>]
|
231
|
+
# The set of field mask paths.
|
232
|
+
class FieldMask
|
233
|
+
include Google::Protobuf::MessageExts
|
234
|
+
extend Google::Protobuf::MessageExts::ClassMethods
|
235
|
+
end
|
236
|
+
end
|
237
|
+
end
|