Package com.google.protobuf
Class FieldMask.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderType>
-
- com.google.protobuf.GeneratedMessageV3.Builder<FieldMask.Builder>
-
- com.google.protobuf.FieldMask.Builder
-
- All Implemented Interfaces:
FieldMaskOrBuilder
,Message.Builder
,MessageLite.Builder
,MessageLiteOrBuilder
,MessageOrBuilder
,Cloneable
- Enclosing class:
- FieldMask
public static final class FieldMask.Builder extends GeneratedMessageV3.Builder<FieldMask.Builder> implements FieldMaskOrBuilder
`FieldMask` represents a set of symbolic field paths, for example: paths: "f.a" paths: "f.b.d" Here `f` represents a field in some root message, `a` and `b` fields in the message found in `f`, and `d` a field found in the message in `f.b`. Field masks are used to specify a subset of fields that should be returned by a get operation or modified by an update operation. Field masks also have a custom JSON encoding (see below). # Field Masks in Projections When used in the context of a projection, a response message or sub-message is filtered by the API to only contain those fields as specified in the mask. For example, if the mask in the previous example is applied to a response message as follows: f { a : 22 b { d : 1 x : 2 } y : 13 } z: 8 The result will not contain specific values for fields x,y and z (their value will be set to the default, and omitted in proto text output): f { a : 22 b { d : 1 } } A repeated field is not allowed except at the last position of a paths string. If a FieldMask object is not present in a get operation, the operation applies to all fields (as if a FieldMask of all fields had been specified). Note that a field mask does not necessarily apply to the top-level response message. In case of a REST get operation, the field mask applies directly to the response, but in case of a REST list operation, the mask instead applies to each individual message in the returned resource list. In case of a REST custom method, other definitions may be used. Where the mask applies will be clearly documented together with its declaration in the API. In any case, the effect on the returned resource/resources is required behavior for APIs. # Field Masks in Update Operations A field mask in update operations specifies which fields of the targeted resource are going to be updated. The API is required to only change the values of the fields as specified in the mask and leave the others untouched. If a resource is passed in to describe the updated values, the API ignores the values of all fields not covered by the mask. If a repeated field is specified for an update operation, new values will be appended to the existing repeated field in the target resource. Note that a repeated field is only allowed in the last position of a `paths` string. If a sub-message is specified in the last position of the field mask for an update operation, then new value will be merged into the existing sub-message in the target resource. For example, given the target message: f { b { d: 1 x: 2 } c: [1] } And an update message: f { b { d: 10 } c: [2] } then if the field mask is: paths: ["f.b", "f.c"] then the result will be: f { b { d: 10 x: 2 } c: [1, 2] } An implementation may provide options to override this default behavior for repeated and message fields. In order to reset a field's value to the default, the field must be in the mask and set to the default value in the provided resource. Hence, in order to reset all fields of a resource, provide a default instance of the resource and set all fields in the mask, or do not provide a mask as described below. If a field mask is not present on update, the operation applies to all fields (as if a field mask of all fields has been specified). Note that in the presence of schema evolution, this may mean that fields the client does not know and has therefore not filled into the request will be reset to their default. If this is unwanted behavior, a specific service may require a client to always specify a field mask, producing an error if not. As with get operations, the location of the resource which describes the updated values in the request message depends on the operation kind. In any case, the effect of the field mask is required to be honored by the API. ## Considerations for HTTP REST The HTTP kind of an update operation which uses a field mask must be set to PATCH instead of PUT in order to satisfy HTTP semantics (PUT must only be used for full updates). # JSON Encoding of Field Masks In JSON, a field mask is encoded as a single string where paths are separated by a comma. Fields name in each path are converted to/from lower-camel naming conventions. As an example, consider the following message declarations: message Profile { User user = 1; Photo photo = 2; } message User { string display_name = 1; string address = 2; } In proto a field mask for `Profile` may look as such: mask { paths: "user.display_name" paths: "photo" } In JSON, the same mask is represented as below: { mask: "user.displayName,photo" } # Field Masks and Oneof Fields Field masks treat fields in oneofs just as regular fields. Consider the following message: message SampleMessage { oneof test_oneof { string name = 4; SubMessage sub_message = 9; } } The field mask can be: mask { paths: "name" } Or: mask { paths: "sub_message" } Note that oneof type names ("test_oneof" in this case) cannot be used in paths. ## Field Mask Verification The implementation of any API method which has a FieldMask type field in the request should verify the included field paths, and return an `INVALID_ARGUMENT` error if any path is unmappable.
Protobuf typegoogle.protobuf.FieldMask
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description FieldMask.Builder
addAllPaths(Iterable<String> values)
The set of field mask paths.FieldMask.Builder
addPaths(String value)
The set of field mask paths.FieldMask.Builder
addPathsBytes(ByteString value)
The set of field mask paths.FieldMask.Builder
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
LikesetRepeatedField
, but appends the value as a new element.FieldMask
build()
Constructs the message based on the state of the Builder.FieldMask
buildPartial()
LikeMessageLite.Builder.build()
, but does not throw an exception if the message is missing required fields.FieldMask.Builder
clear()
Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.FieldMask.Builder
clearField(Descriptors.FieldDescriptor field)
Clears the field.FieldMask.Builder
clearOneof(Descriptors.OneofDescriptor oneof)
TODO(jieluo): Clear it when all subclasses have implemented this method.FieldMask.Builder
clearPaths()
The set of field mask paths.FieldMask.Builder
clone()
Clones the Builder.FieldMask
getDefaultInstanceForType()
Get an instance of the type with no fields set.static Descriptors.Descriptor
getDescriptor()
Descriptors.Descriptor
getDescriptorForType()
Get the message's type's descriptor.String
getPaths(int index)
The set of field mask paths.ByteString
getPathsBytes(int index)
The set of field mask paths.int
getPathsCount()
The set of field mask paths.ProtocolStringList
getPathsList()
The set of field mask paths.protected GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
Get the FieldAccessorTable for this type.boolean
isInitialized()
Returns true if all required fields in the message and all embedded messages are set, false otherwise.FieldMask.Builder
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
LikeMessageLite.Builder.mergeFrom(CodedInputStream)
, but also parses extensions.FieldMask.Builder
mergeFrom(FieldMask other)
FieldMask.Builder
mergeFrom(Message other)
Mergeother
into the message being built.FieldMask.Builder
mergeUnknownFields(UnknownFieldSet unknownFields)
Merge some unknown fields into theUnknownFieldSet
for this message.FieldMask.Builder
setField(Descriptors.FieldDescriptor field, Object value)
Sets a field to the given value.FieldMask.Builder
setPaths(int index, String value)
The set of field mask paths.FieldMask.Builder
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Sets an element of a repeated field to the given value.FieldMask.Builder
setUnknownFields(UnknownFieldSet unknownFields)
Set theUnknownFieldSet
for this message.-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
-
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getDescriptor
public static final Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Description copied from class:GeneratedMessageV3.Builder
Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.- Specified by:
internalGetFieldAccessorTable
in classGeneratedMessageV3.Builder<FieldMask.Builder>
-
clear
public FieldMask.Builder clear()
Description copied from class:GeneratedMessageV3.Builder
Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.- Specified by:
clear
in interfaceMessage.Builder
- Specified by:
clear
in interfaceMessageLite.Builder
- Overrides:
clear
in classGeneratedMessageV3.Builder<FieldMask.Builder>
-
getDescriptorForType
public Descriptors.Descriptor getDescriptorForType()
Description copied from interface:Message.Builder
Get the message's type's descriptor. SeeMessageOrBuilder.getDescriptorForType()
.- Specified by:
getDescriptorForType
in interfaceMessage.Builder
- Specified by:
getDescriptorForType
in interfaceMessageOrBuilder
- Overrides:
getDescriptorForType
in classGeneratedMessageV3.Builder<FieldMask.Builder>
-
getDefaultInstanceForType
public FieldMask getDefaultInstanceForType()
Description copied from interface:MessageLiteOrBuilder
Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from thegetDefaultInstance()
method of generated message classes in that this method is an abstract method of theMessageLite
interface whereasgetDefaultInstance()
is a static method of a specific class. They return the same thing.- Specified by:
getDefaultInstanceForType
in interfaceMessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfaceMessageOrBuilder
-
build
public FieldMask build()
Description copied from interface:MessageLite.Builder
Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.- Specified by:
build
in interfaceMessage.Builder
- Specified by:
build
in interfaceMessageLite.Builder
-
buildPartial
public FieldMask buildPartial()
Description copied from interface:MessageLite.Builder
LikeMessageLite.Builder.build()
, but does not throw an exception if the message is missing required fields. Instead, a partial message is returned. Subsequent changes to the Builder will not affect the returned message.- Specified by:
buildPartial
in interfaceMessage.Builder
- Specified by:
buildPartial
in interfaceMessageLite.Builder
-
clone
public FieldMask.Builder clone()
Description copied from interface:MessageLite.Builder
Clones the Builder.- Specified by:
clone
in interfaceMessage.Builder
- Specified by:
clone
in interfaceMessageLite.Builder
- Overrides:
clone
in classGeneratedMessageV3.Builder<FieldMask.Builder>
- See Also:
Object.clone()
-
setField
public FieldMask.Builder setField(Descriptors.FieldDescriptor field, Object value)
Description copied from interface:Message.Builder
Sets a field to the given value. The value must be of the correct type for this field, that is, the same type thatMessageOrBuilder.getField(Descriptors.FieldDescriptor)
returns.- Specified by:
setField
in interfaceMessage.Builder
- Overrides:
setField
in classGeneratedMessageV3.Builder<FieldMask.Builder>
-
clearField
public FieldMask.Builder clearField(Descriptors.FieldDescriptor field)
Description copied from interface:Message.Builder
Clears the field. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the field.- Specified by:
clearField
in interfaceMessage.Builder
- Overrides:
clearField
in classGeneratedMessageV3.Builder<FieldMask.Builder>
-
clearOneof
public FieldMask.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Description copied from class:AbstractMessage.Builder
TODO(jieluo): Clear it when all subclasses have implemented this method.- Specified by:
clearOneof
in interfaceMessage.Builder
- Overrides:
clearOneof
in classGeneratedMessageV3.Builder<FieldMask.Builder>
-
setRepeatedField
public FieldMask.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Description copied from interface:Message.Builder
Sets an element of a repeated field to the given value. The value must be of the correct type for this field; that is, the same type thatMessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int)
returns.- Specified by:
setRepeatedField
in interfaceMessage.Builder
- Overrides:
setRepeatedField
in classGeneratedMessageV3.Builder<FieldMask.Builder>
-
addRepeatedField
public FieldMask.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Description copied from interface:Message.Builder
LikesetRepeatedField
, but appends the value as a new element.- Specified by:
addRepeatedField
in interfaceMessage.Builder
- Overrides:
addRepeatedField
in classGeneratedMessageV3.Builder<FieldMask.Builder>
-
mergeFrom
public FieldMask.Builder mergeFrom(Message other)
Description copied from interface:Message.Builder
Mergeother
into the message being built.other
must have the exact same type asthis
(i.e.getDescriptorForType() == other.getDescriptorForType()
).Merging occurs as follows. For each field:
* For singular primitive fields, if the field is set inother
, thenother
's value overwrites the value in this message.
* For singular message fields, if the field is set inother
, it is merged into the corresponding sub-message of this message using the same merging rules.
* For repeated fields, the elements inother
are concatenated with the elements in this message.
* For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved.This is equivalent to the
Message::MergeFrom
method in C++.- Specified by:
mergeFrom
in interfaceMessage.Builder
- Overrides:
mergeFrom
in classAbstractMessage.Builder<FieldMask.Builder>
-
mergeFrom
public FieldMask.Builder mergeFrom(FieldMask other)
-
isInitialized
public final boolean isInitialized()
Description copied from interface:MessageLiteOrBuilder
Returns true if all required fields in the message and all embedded messages are set, false otherwise.- Specified by:
isInitialized
in interfaceMessageLiteOrBuilder
- Overrides:
isInitialized
in classGeneratedMessageV3.Builder<FieldMask.Builder>
-
mergeFrom
public FieldMask.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
Description copied from interface:MessageLite.Builder
LikeMessageLite.Builder.mergeFrom(CodedInputStream)
, but also parses extensions. The extensions that you want to be able to parse must be registered inextensionRegistry
. Extensions not in the registry will be treated as unknown fields.- Specified by:
mergeFrom
in interfaceMessage.Builder
- Specified by:
mergeFrom
in interfaceMessageLite.Builder
- Overrides:
mergeFrom
in classAbstractMessage.Builder<FieldMask.Builder>
- Throws:
InvalidProtocolBufferException
- the bytes read are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.IOException
- an I/O error reading from the stream
-
getPathsList
public ProtocolStringList getPathsList()
The set of field mask paths.
repeated string paths = 1;
- Specified by:
getPathsList
in interfaceFieldMaskOrBuilder
- Returns:
- A list containing the paths.
-
getPathsCount
public int getPathsCount()
The set of field mask paths.
repeated string paths = 1;
- Specified by:
getPathsCount
in interfaceFieldMaskOrBuilder
- Returns:
- The count of paths.
-
getPaths
public String getPaths(int index)
The set of field mask paths.
repeated string paths = 1;
- Specified by:
getPaths
in interfaceFieldMaskOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The paths at the given index.
-
getPathsBytes
public ByteString getPathsBytes(int index)
The set of field mask paths.
repeated string paths = 1;
- Specified by:
getPathsBytes
in interfaceFieldMaskOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the paths at the given index.
-
setPaths
public FieldMask.Builder setPaths(int index, String value)
The set of field mask paths.
repeated string paths = 1;
- Parameters:
index
- The index to set the value at.value
- The paths to set.- Returns:
- This builder for chaining.
-
addPaths
public FieldMask.Builder addPaths(String value)
The set of field mask paths.
repeated string paths = 1;
- Parameters:
value
- The paths to add.- Returns:
- This builder for chaining.
-
addAllPaths
public FieldMask.Builder addAllPaths(Iterable<String> values)
The set of field mask paths.
repeated string paths = 1;
- Parameters:
values
- The paths to add.- Returns:
- This builder for chaining.
-
clearPaths
public FieldMask.Builder clearPaths()
The set of field mask paths.
repeated string paths = 1;
- Returns:
- This builder for chaining.
-
addPathsBytes
public FieldMask.Builder addPathsBytes(ByteString value)
The set of field mask paths.
repeated string paths = 1;
- Parameters:
value
- The bytes of the paths to add.- Returns:
- This builder for chaining.
-
setUnknownFields
public final FieldMask.Builder setUnknownFields(UnknownFieldSet unknownFields)
Description copied from interface:Message.Builder
Set theUnknownFieldSet
for this message.- Specified by:
setUnknownFields
in interfaceMessage.Builder
- Overrides:
setUnknownFields
in classGeneratedMessageV3.Builder<FieldMask.Builder>
-
mergeUnknownFields
public final FieldMask.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Description copied from interface:Message.Builder
Merge some unknown fields into theUnknownFieldSet
for this message.- Specified by:
mergeUnknownFields
in interfaceMessage.Builder
- Overrides:
mergeUnknownFields
in classGeneratedMessageV3.Builder<FieldMask.Builder>
-
-