Package com.google.protobuf
Class Method.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderType>
-
- com.google.protobuf.GeneratedMessageV3.Builder<Method.Builder>
-
- com.google.protobuf.Method.Builder
-
- All Implemented Interfaces:
Message.Builder
,MessageLite.Builder
,MessageLiteOrBuilder
,MessageOrBuilder
,MethodOrBuilder
,java.lang.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 typegoogle.protobuf.Method
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Method.Builder
addAllOptions(java.lang.Iterable<? extends Option> values)
Any metadata attached to the method.Method.Builder
addOptions(int index, Option value)
Any metadata attached to the method.Method.Builder
addOptions(int index, Option.Builder builderForValue)
Any metadata attached to the method.Method.Builder
addOptions(Option value)
Any metadata attached to the method.Method.Builder
addOptions(Option.Builder builderForValue)
Any metadata attached to the method.Option.Builder
addOptionsBuilder()
Any metadata attached to the method.Option.Builder
addOptionsBuilder(int index)
Any metadata attached to the method.Method.Builder
addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
LikesetRepeatedField
, but appends the value as a new element.Method
build()
Constructs the message based on the state of the Builder.Method
buildPartial()
LikeMessageLite.Builder.build()
, but does not throw an exception if the message is missing required fields.Method.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.Method.Builder
clearField(Descriptors.FieldDescriptor field)
Clears the field.Method.Builder
clearName()
The simple name of this method.Method.Builder
clearOneof(Descriptors.OneofDescriptor oneof)
TODO(jieluo): Clear it when all subclasses have implemented this method.Method.Builder
clearOptions()
Any metadata attached to the method.Method.Builder
clearRequestStreaming()
If true, the request is streamed.Method.Builder
clearRequestTypeUrl()
A URL of the input message type.Method.Builder
clearResponseStreaming()
If true, the response is streamed.Method.Builder
clearResponseTypeUrl()
The URL of the output message type.Method.Builder
clearSyntax()
The source syntax of this method.Method.Builder
clone()
Clones the Builder.Method
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.java.lang.String
getName()
The simple name of this method.ByteString
getNameBytes()
The simple name of this method.Option
getOptions(int index)
Any metadata attached to the method.Option.Builder
getOptionsBuilder(int index)
Any metadata attached to the method.java.util.List<Option.Builder>
getOptionsBuilderList()
Any metadata attached to the method.int
getOptionsCount()
Any metadata attached to the method.java.util.List<Option>
getOptionsList()
Any metadata attached to the method.OptionOrBuilder
getOptionsOrBuilder(int index)
Any metadata attached to the method.java.util.List<? extends OptionOrBuilder>
getOptionsOrBuilderList()
Any metadata attached to the method.boolean
getRequestStreaming()
If true, the request is streamed.java.lang.String
getRequestTypeUrl()
A URL of the input message type.ByteString
getRequestTypeUrlBytes()
A URL of the input message type.boolean
getResponseStreaming()
If true, the response is streamed.java.lang.String
getResponseTypeUrl()
The URL of the output message type.ByteString
getResponseTypeUrlBytes()
The URL of the output message type.Syntax
getSyntax()
The source syntax of this method.int
getSyntaxValue()
The source syntax of this method.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.Method.Builder
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
LikeMessageLite.Builder.mergeFrom(CodedInputStream)
, but also parses extensions.Method.Builder
mergeFrom(Message other)
Mergeother
into the message being built.Method.Builder
mergeFrom(Method other)
Method.Builder
mergeUnknownFields(UnknownFieldSet unknownFields)
Merge some unknown fields into theUnknownFieldSet
for this message.Method.Builder
removeOptions(int index)
Any metadata attached to the method.Method.Builder
setField(Descriptors.FieldDescriptor field, java.lang.Object value)
Sets a field to the given value.Method.Builder
setName(java.lang.String value)
The simple name of this method.Method.Builder
setNameBytes(ByteString value)
The simple name of this method.Method.Builder
setOptions(int index, Option value)
Any metadata attached to the method.Method.Builder
setOptions(int index, Option.Builder builderForValue)
Any metadata attached to the method.Method.Builder
setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
Sets an element of a repeated field to the given value.Method.Builder
setRequestStreaming(boolean value)
If true, the request is streamed.Method.Builder
setRequestTypeUrl(java.lang.String value)
A URL of the input message type.Method.Builder
setRequestTypeUrlBytes(ByteString value)
A URL of the input message type.Method.Builder
setResponseStreaming(boolean value)
If true, the response is streamed.Method.Builder
setResponseTypeUrl(java.lang.String value)
The URL of the output message type.Method.Builder
setResponseTypeUrlBytes(ByteString value)
The URL of the output message type.Method.Builder
setSyntax(Syntax value)
The source syntax of this method.Method.Builder
setSyntaxValue(int value)
The source syntax of this method.Method.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, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, 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
-
-
-
-
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<Method.Builder>
-
clear
public 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
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<Method.Builder>
-
getDefaultInstanceForType
public Method 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 Method 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 Method 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 Method.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:
Object.clone()
-
setField
public Method.Builder setField(Descriptors.FieldDescriptor field, java.lang.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, 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
public Method.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<Method.Builder>
-
clearOneof
public Method.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<Method.Builder>
-
setRepeatedField
public Method.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.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, 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
public Method.Builder addRepeatedField(Descriptors.FieldDescriptor field, java.lang.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<Method.Builder>
-
mergeFrom
public Method.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<Method.Builder>
-
mergeFrom
public Method.Builder mergeFrom(Method 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<Method.Builder>
-
mergeFrom
public Method.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.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:
java.io.IOException
-
getName
public java.lang.String getName()
The simple name of this method.
string name = 1;
- Specified by:
getName
in interfaceMethodOrBuilder
- Returns:
- The name.
-
getNameBytes
public ByteString getNameBytes()
The simple name of this method.
string name = 1;
- Specified by:
getNameBytes
in interfaceMethodOrBuilder
- Returns:
- The bytes for name.
-
setName
public Method.Builder setName(java.lang.String value)
The simple name of this method.
string name = 1;
- Parameters:
value
- The name to set.- Returns:
- This builder for chaining.
-
clearName
public Method.Builder clearName()
The simple name of this method.
string name = 1;
- Returns:
- This builder for chaining.
-
setNameBytes
public Method.Builder setNameBytes(ByteString value)
The simple name of this method.
string name = 1;
- Parameters:
value
- The bytes for name to set.- Returns:
- This builder for chaining.
-
getRequestTypeUrl
public java.lang.String getRequestTypeUrl()
A URL of the input message type.
string request_type_url = 2;
- Specified by:
getRequestTypeUrl
in interfaceMethodOrBuilder
- Returns:
- The requestTypeUrl.
-
getRequestTypeUrlBytes
public ByteString getRequestTypeUrlBytes()
A URL of the input message type.
string request_type_url = 2;
- Specified by:
getRequestTypeUrlBytes
in interfaceMethodOrBuilder
- Returns:
- The bytes for requestTypeUrl.
-
setRequestTypeUrl
public Method.Builder setRequestTypeUrl(java.lang.String value)
A URL of the input message type.
string request_type_url = 2;
- Parameters:
value
- The requestTypeUrl to set.- Returns:
- This builder for chaining.
-
clearRequestTypeUrl
public Method.Builder clearRequestTypeUrl()
A URL of the input message type.
string request_type_url = 2;
- Returns:
- This builder for chaining.
-
setRequestTypeUrlBytes
public Method.Builder setRequestTypeUrlBytes(ByteString value)
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
public Method.Builder setRequestStreaming(boolean value)
If true, the request is streamed.
bool request_streaming = 3;
- Parameters:
value
- The requestStreaming to set.- Returns:
- This builder for chaining.
-
clearRequestStreaming
public Method.Builder clearRequestStreaming()
If true, the request is streamed.
bool request_streaming = 3;
- Returns:
- This builder for chaining.
-
getResponseTypeUrl
public java.lang.String getResponseTypeUrl()
The URL of the output message type.
string response_type_url = 4;
- Specified by:
getResponseTypeUrl
in interfaceMethodOrBuilder
- Returns:
- The responseTypeUrl.
-
getResponseTypeUrlBytes
public ByteString getResponseTypeUrlBytes()
The URL of the output message type.
string response_type_url = 4;
- Specified by:
getResponseTypeUrlBytes
in interfaceMethodOrBuilder
- Returns:
- The bytes for responseTypeUrl.
-
setResponseTypeUrl
public Method.Builder setResponseTypeUrl(java.lang.String value)
The URL of the output message type.
string response_type_url = 4;
- Parameters:
value
- The responseTypeUrl to set.- Returns:
- This builder for chaining.
-
clearResponseTypeUrl
public Method.Builder clearResponseTypeUrl()
The URL of the output message type.
string response_type_url = 4;
- Returns:
- This builder for chaining.
-
setResponseTypeUrlBytes
public Method.Builder setResponseTypeUrlBytes(ByteString value)
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
public Method.Builder setResponseStreaming(boolean value)
If true, the response is streamed.
bool response_streaming = 5;
- Parameters:
value
- The responseStreaming to set.- Returns:
- This builder for chaining.
-
clearResponseStreaming
public Method.Builder clearResponseStreaming()
If true, the response is streamed.
bool response_streaming = 5;
- Returns:
- This builder for chaining.
-
getOptionsList
public java.util.List<Option> 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
public Option getOptions(int index)
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
- Specified by:
getOptions
in interfaceMethodOrBuilder
-
setOptions
public Method.Builder setOptions(int index, Option value)
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
setOptions
public Method.Builder setOptions(int index, Option.Builder builderForValue)
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
addOptions
public Method.Builder addOptions(Option value)
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
addOptions
public Method.Builder addOptions(int index, Option value)
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
addOptions
public Method.Builder addOptions(Option.Builder builderForValue)
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
addOptions
public Method.Builder addOptions(int index, Option.Builder builderForValue)
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
addAllOptions
public Method.Builder addAllOptions(java.lang.Iterable<? extends Option> values)
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
clearOptions
public Method.Builder clearOptions()
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
removeOptions
public Method.Builder removeOptions(int index)
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
getOptionsBuilder
public Option.Builder getOptionsBuilder(int index)
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
getOptionsOrBuilder
public OptionOrBuilder getOptionsOrBuilder(int index)
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
- Specified by:
getOptionsOrBuilder
in interfaceMethodOrBuilder
-
getOptionsOrBuilderList
public java.util.List<? extends OptionOrBuilder> getOptionsOrBuilderList()
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
- Specified by:
getOptionsOrBuilderList
in interfaceMethodOrBuilder
-
addOptionsBuilder
public Option.Builder addOptionsBuilder()
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
addOptionsBuilder
public Option.Builder addOptionsBuilder(int index)
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
getOptionsBuilderList
public java.util.List<Option.Builder> getOptionsBuilderList()
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
-
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
public Method.Builder setSyntaxValue(int value)
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
public Syntax getSyntax()
The source syntax of this method.
.google.protobuf.Syntax syntax = 7;
- Specified by:
getSyntax
in interfaceMethodOrBuilder
- Returns:
- The syntax.
-
setSyntax
public Method.Builder setSyntax(Syntax value)
The source syntax of this method.
.google.protobuf.Syntax syntax = 7;
- Parameters:
value
- The syntax to set.- Returns:
- This builder for chaining.
-
clearSyntax
public Method.Builder clearSyntax()
The source syntax of this method.
.google.protobuf.Syntax syntax = 7;
- Returns:
- This builder for chaining.
-
setUnknownFields
public final Method.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<Method.Builder>
-
mergeUnknownFields
public final Method.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<Method.Builder>
-
-