Package com.google.protobuf
Class Method.Builder
java.lang.Object
- All Implemented Interfaces:
Message.Builder
,MessageLite.Builder
,MessageLiteOrBuilder
,MessageOrBuilder
,MethodOrBuilder
,Cloneable
- Enclosing class:
Method
public static final class Method.Builder
extends GeneratedMessageV3.Builder<Method.Builder>
implements MethodOrBuilder
Method represents a method of an API interface.Protobuf type
google.protobuf.Method
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite.Builder
AbstractMessageLite.Builder.LimitedInputStream
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAllOptions
(Iterable<? extends Option> values) Any metadata attached to the method.addOptions
(int index, Option value) Any metadata attached to the method.addOptions
(int index, Option.Builder builderForValue) Any metadata attached to the method.addOptions
(Option value) Any metadata attached to the method.addOptions
(Option.Builder builderForValue) Any metadata attached to the method.Any metadata attached to the method.addOptionsBuilder
(int index) Any metadata attached to the method.addRepeatedField
(Descriptors.FieldDescriptor field, Object value) LikesetRepeatedField
, but appends the value as a new element.build()
Constructs the message based on the state of the Builder.LikeMessageLite.Builder.build()
, but does not throw an exception if the message is missing required fields.clear()
Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.Clears the field.The simple name of this method.TODO(jieluo): Clear it when all subclasses have implemented this method.Any metadata attached to the method.If true, the request is streamed.A URL of the input message type.If true, the response is streamed.The URL of the output message type.The source syntax of this method.clone()
Clones the Builder.private void
Get an instance of the type with no fields set.static final Descriptors.Descriptor
Get the message's type's descriptor.getName()
The simple name of this method.The simple name of this method.getOptions
(int index) Any metadata attached to the method.getOptionsBuilder
(int index) Any metadata attached to the method.Any metadata attached to the method.int
Any metadata attached to the method.Any metadata attached to the method.getOptionsOrBuilder
(int index) Any metadata attached to the method.List
<? extends OptionOrBuilder> Any metadata attached to the method.boolean
If true, the request is streamed.A URL of the input message type.A URL of the input message type.boolean
If true, the response is streamed.The URL of the output message type.The URL of the output message type.The source syntax of this method.int
The source syntax of this method.protected GeneratedMessageV3.FieldAccessorTable
Get the FieldAccessorTable for this type.final boolean
Returns true if all required fields in the message and all embedded messages are set, false otherwise.mergeFrom
(CodedInputStream input, ExtensionRegistryLite extensionRegistry) LikeMessageLite.Builder.mergeFrom(CodedInputStream)
, but also parses extensions.Mergeother
into the message being built.final Method.Builder
mergeUnknownFields
(UnknownFieldSet unknownFields) Merge some unknown fields into theUnknownFieldSet
for this message.removeOptions
(int index) Any metadata attached to the method.setField
(Descriptors.FieldDescriptor field, Object value) Sets a field to the given value.The simple name of this method.setNameBytes
(ByteString value) The simple name of this method.setOptions
(int index, Option value) Any metadata attached to the method.setOptions
(int index, Option.Builder builderForValue) Any metadata attached to the method.setRepeatedField
(Descriptors.FieldDescriptor field, int index, Object value) Sets an element of a repeated field to the given value.setRequestStreaming
(boolean value) If true, the request is streamed.setRequestTypeUrl
(String value) A URL of the input message type.setRequestTypeUrlBytes
(ByteString value) A URL of the input message type.setResponseStreaming
(boolean value) If true, the response is streamed.setResponseTypeUrl
(String value) The URL of the output message type.The URL of the output message type.The source syntax of this method.setSyntaxValue
(int value) The source syntax of this method.final Method.Builder
setUnknownFields
(UnknownFieldSet unknownFields) Set theUnknownFieldSet
for this message.Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
dispose, 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, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, 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.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
bitField0_
private int bitField0_ -
name_
-
requestTypeUrl_
-
requestStreaming_
private boolean requestStreaming_ -
responseTypeUrl_
-
responseStreaming_
private boolean responseStreaming_ -
options_
-
optionsBuilder_
-
syntax_
private int syntax_
-
-
Constructor Details
-
Builder
private Builder() -
Builder
-
-
Method Details
-
getDescriptor
-
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<Method.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<Method.Builder>
-
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<Method.Builder>
-
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
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
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
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<Method.Builder>
- See Also:
-
setField
Description copied from interface:Message.Builder
Sets a field to the given value. The value must be of the correct type for this field, i.e. the same type thatMessageOrBuilder.getField(Descriptors.FieldDescriptor)
would return.- Specified by:
setField
in interfaceMessage.Builder
- Overrides:
setField
in classGeneratedMessageV3.Builder<Method.Builder>
-
clearField
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<Method.Builder>
-
clearOneof
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<Method.Builder>
-
setRepeatedField
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, i.e. the same type thatMessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int)
would return.- Specified by:
setRepeatedField
in interfaceMessage.Builder
- Overrides:
setRepeatedField
in classGeneratedMessageV3.Builder<Method.Builder>
-
addRepeatedField
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<Method.Builder>
-
mergeFrom
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<Method.Builder>
-
mergeFrom
-
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<Method.Builder>
-
mergeFrom
public Method.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<Method.Builder>
- Throws:
IOException
-
getName
The simple name of this method.
string name = 1;
- Specified by:
getName
in interfaceMethodOrBuilder
- Returns:
- The name.
-
getNameBytes
The simple name of this method.
string name = 1;
- Specified by:
getNameBytes
in interfaceMethodOrBuilder
- Returns:
- The bytes for name.
-
setName
The simple name of this method.
string name = 1;
- Parameters:
value
- The name to set.- Returns:
- This builder for chaining.
-
clearName
The simple name of this method.
string name = 1;
- Returns:
- This builder for chaining.
-
setNameBytes
The simple name of this method.
string name = 1;
- Parameters:
value
- The bytes for name to set.- Returns:
- This builder for chaining.
-
getRequestTypeUrl
A URL of the input message type.
string request_type_url = 2;
- Specified by:
getRequestTypeUrl
in interfaceMethodOrBuilder
- Returns:
- The requestTypeUrl.
-
getRequestTypeUrlBytes
A URL of the input message type.
string request_type_url = 2;
- Specified by:
getRequestTypeUrlBytes
in interfaceMethodOrBuilder
- Returns:
- The bytes for requestTypeUrl.
-
setRequestTypeUrl
A URL of the input message type.
string request_type_url = 2;
- Parameters:
value
- The requestTypeUrl to set.- Returns:
- This builder for chaining.
-
clearRequestTypeUrl
A URL of the input message type.
string request_type_url = 2;
- Returns:
- This builder for chaining.
-
setRequestTypeUrlBytes
A URL of the input message type.
string request_type_url = 2;
- Parameters:
value
- The bytes for requestTypeUrl to set.- Returns:
- This builder for chaining.
-
getRequestStreaming
public boolean getRequestStreaming()If true, the request is streamed.
bool request_streaming = 3;
- Specified by:
getRequestStreaming
in interfaceMethodOrBuilder
- Returns:
- The requestStreaming.
-
setRequestStreaming
If true, the request is streamed.
bool request_streaming = 3;
- Parameters:
value
- The requestStreaming to set.- Returns:
- This builder for chaining.
-
clearRequestStreaming
If true, the request is streamed.
bool request_streaming = 3;
- Returns:
- This builder for chaining.
-
getResponseTypeUrl
The URL of the output message type.
string response_type_url = 4;
- Specified by:
getResponseTypeUrl
in interfaceMethodOrBuilder
- Returns:
- The responseTypeUrl.
-
getResponseTypeUrlBytes
The URL of the output message type.
string response_type_url = 4;
- Specified by:
getResponseTypeUrlBytes
in interfaceMethodOrBuilder
- Returns:
- The bytes for responseTypeUrl.
-
setResponseTypeUrl
The URL of the output message type.
string response_type_url = 4;
- Parameters:
value
- The responseTypeUrl to set.- Returns:
- This builder for chaining.
-
clearResponseTypeUrl
The URL of the output message type.
string response_type_url = 4;
- Returns:
- This builder for chaining.
-
setResponseTypeUrlBytes
The URL of the output message type.
string response_type_url = 4;
- Parameters:
value
- The bytes for responseTypeUrl to set.- Returns:
- This builder for chaining.
-
getResponseStreaming
public boolean getResponseStreaming()If true, the response is streamed.
bool response_streaming = 5;
- Specified by:
getResponseStreaming
in interfaceMethodOrBuilder
- Returns:
- The responseStreaming.
-
setResponseStreaming
If true, the response is streamed.
bool response_streaming = 5;
- Parameters:
value
- The responseStreaming to set.- Returns:
- This builder for chaining.
-
clearResponseStreaming
If true, the response is streamed.
bool response_streaming = 5;
- Returns:
- This builder for chaining.
-
ensureOptionsIsMutable
private void ensureOptionsIsMutable() -
getOptionsList
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
- Specified by:
getOptionsList
in interfaceMethodOrBuilder
-
getOptionsCount
public int getOptionsCount()Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
- Specified by:
getOptionsCount
in interfaceMethodOrBuilder
-
getOptions
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
- Specified by:
getOptions
in interfaceMethodOrBuilder
-
setOptions
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
setOptions
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
addOptions
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
addOptions
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
addOptions
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
addOptions
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
addAllOptions
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
clearOptions
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
removeOptions
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
getOptionsBuilder
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
getOptionsOrBuilder
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
- Specified by:
getOptionsOrBuilder
in interfaceMethodOrBuilder
-
getOptionsOrBuilderList
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
- Specified by:
getOptionsOrBuilderList
in interfaceMethodOrBuilder
-
addOptionsBuilder
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
addOptionsBuilder
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
getOptionsBuilderList
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
getOptionsFieldBuilder
-
getSyntaxValue
public int getSyntaxValue()The source syntax of this method.
.google.protobuf.Syntax syntax = 7;
- Specified by:
getSyntaxValue
in interfaceMethodOrBuilder
- Returns:
- The enum numeric value on the wire for syntax.
-
setSyntaxValue
The source syntax of this method.
.google.protobuf.Syntax syntax = 7;
- Parameters:
value
- The enum numeric value on the wire for syntax to set.- Returns:
- This builder for chaining.
-
getSyntax
The source syntax of this method.
.google.protobuf.Syntax syntax = 7;
- Specified by:
getSyntax
in interfaceMethodOrBuilder
- Returns:
- The syntax.
-
setSyntax
The source syntax of this method.
.google.protobuf.Syntax syntax = 7;
- Parameters:
value
- The syntax to set.- Returns:
- This builder for chaining.
-
clearSyntax
The source syntax of this method.
.google.protobuf.Syntax syntax = 7;
- Returns:
- This builder for chaining.
-
setUnknownFields
Description copied from interface:Message.Builder
Set theUnknownFieldSet
for this message.- Specified by:
setUnknownFields
in interfaceMessage.Builder
- Overrides:
setUnknownFields
in classGeneratedMessageV3.Builder<Method.Builder>
-
mergeUnknownFields
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<Method.Builder>
-