Package com.google.protobuf
Class Method
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.protobuf.Method
- All Implemented Interfaces:
Message
,MessageLite
,MessageLiteOrBuilder
,MessageOrBuilder
,MethodOrBuilder
,Serializable
Method represents a method of an API interface.Protobuf type
google.protobuf.Method
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Method represents a method of an API interface.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,
BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType, BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtensionDescriptorRetriever, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final Method
private byte
private Object
static final int
static final int
static final int
static final int
private boolean
private Object
static final int
static final int
private boolean
private Object
private static final long
private int
static final int
Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Method()
private
Method
(GeneratedMessageV3.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compares the specified object with this message for equality.static Method
Get an instance of the type with no fields set.static final Descriptors.Descriptor
getName()
The simple name of this method.The simple name of this method.getOptions
(int index) 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.Gets the parser for a message of the same type as this message.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.int
Get the number of bytes required to encode this message.The source syntax of this method.int
The source syntax of this method.final UnknownFieldSet
Get theUnknownFieldSet
for this message.int
hashCode()
Returns the hash code value for this message.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.static Method.Builder
static Method.Builder
newBuilder
(Method prototype) Constructs a new builder for a message of the same type as this message.protected Method.Builder
TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.protected Object
Creates a new instance of this message type.static Method
parseDelimitedFrom
(InputStream input) static Method
parseDelimitedFrom
(InputStream input, ExtensionRegistryLite extensionRegistry) static Method
parseFrom
(byte[] data) static Method
parseFrom
(byte[] data, ExtensionRegistryLite extensionRegistry) static Method
parseFrom
(ByteString data) static Method
parseFrom
(ByteString data, ExtensionRegistryLite extensionRegistry) static Method
parseFrom
(CodedInputStream input) static Method
parseFrom
(CodedInputStream input, ExtensionRegistryLite extensionRegistry) static Method
parseFrom
(InputStream input) static Method
parseFrom
(InputStream input, ExtensionRegistryLite extensionRegistry) static Method
parseFrom
(ByteBuffer data) static Method
parseFrom
(ByteBuffer data, ExtensionRegistryLite extensionRegistry) parser()
Constructs a builder initialized with the current message.void
writeTo
(CodedOutputStream output) Serializes the message and writes it tooutput
.Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, enableAlwaysUseFieldBuildersForTesting, getAllFields, getAllFieldsRaw, getDescriptorForType, getField, getFieldRaw, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, setAlwaysUseFieldBuildersForTesting, writeReplace, writeString, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
compareFields, findInitializationErrors, getInitializationErrorString, getMemoizedSerializedSize, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, newUninitializedMessageException, setMemoizedSerializedSize, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, getSerializedSize, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
name_
-
REQUEST_TYPE_URL_FIELD_NUMBER
public static final int REQUEST_TYPE_URL_FIELD_NUMBER- See Also:
-
requestTypeUrl_
-
REQUEST_STREAMING_FIELD_NUMBER
public static final int REQUEST_STREAMING_FIELD_NUMBER- See Also:
-
requestStreaming_
private boolean requestStreaming_ -
RESPONSE_TYPE_URL_FIELD_NUMBER
public static final int RESPONSE_TYPE_URL_FIELD_NUMBER- See Also:
-
responseTypeUrl_
-
RESPONSE_STREAMING_FIELD_NUMBER
public static final int RESPONSE_STREAMING_FIELD_NUMBER- See Also:
-
responseStreaming_
private boolean responseStreaming_ -
OPTIONS_FIELD_NUMBER
public static final int OPTIONS_FIELD_NUMBER- See Also:
-
options_
-
SYNTAX_FIELD_NUMBER
public static final int SYNTAX_FIELD_NUMBER- See Also:
-
syntax_
private int syntax_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
Method
-
Method
private Method()
-
-
Method Details
-
newInstance
Description copied from class:GeneratedMessageV3
Creates a new instance of this message type. Overridden in the generated code.- Overrides:
newInstance
in classGeneratedMessageV3
-
getUnknownFields
Description copied from interface:MessageOrBuilder
Get theUnknownFieldSet
for this message.- Specified by:
getUnknownFields
in interfaceMessageOrBuilder
- Overrides:
getUnknownFields
in classGeneratedMessageV3
-
getDescriptor
-
internalGetFieldAccessorTable
Description copied from class:GeneratedMessageV3
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
-
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.
-
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.
-
getRequestStreaming
public boolean getRequestStreaming()If true, the request is streamed.
bool request_streaming = 3;
- Specified by:
getRequestStreaming
in interfaceMethodOrBuilder
- Returns:
- The requestStreaming.
-
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.
-
getResponseStreaming
public boolean getResponseStreaming()If true, the response is streamed.
bool response_streaming = 5;
- Specified by:
getResponseStreaming
in interfaceMethodOrBuilder
- Returns:
- The responseStreaming.
-
getOptionsList
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
- Specified by:
getOptionsList
in interfaceMethodOrBuilder
-
getOptionsOrBuilderList
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
- Specified by:
getOptionsOrBuilderList
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
-
getOptionsOrBuilder
Any metadata attached to the method.
repeated .google.protobuf.Option options = 6;
- Specified by:
getOptionsOrBuilder
in interfaceMethodOrBuilder
-
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.
-
getSyntax
The source syntax of this method.
.google.protobuf.Syntax syntax = 7;
- Specified by:
getSyntax
in interfaceMethodOrBuilder
- Returns:
- The syntax.
-
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
-
writeTo
Description copied from interface:MessageLite
Serializes the message and writes it tooutput
. This does not flush or close the stream.- Specified by:
writeTo
in interfaceMessageLite
- Overrides:
writeTo
in classGeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()Description copied from interface:MessageLite
Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that. If this message requires more than Integer.MAX_VALUE bytes to encode, the return value will be smaller than the actual number of bytes required and might be negative.- Specified by:
getSerializedSize
in interfaceMessageLite
- Overrides:
getSerializedSize
in classGeneratedMessageV3
-
equals
Description copied from interface:Message
Compares the specified object with this message for equality. Returnstrue
if the given object is a message of the same type (as defined bygetDescriptorForType()
) and has identical values for all of its fields. Subclasses must implement this; inheritingObject.equals()
is incorrect.- Specified by:
equals
in interfaceMessage
- Overrides:
equals
in classAbstractMessage
- Parameters:
obj
- object to be compared for equality with this message- Returns:
true
if the specified object is equal to this message
-
hashCode
public int hashCode()Description copied from interface:Message
Returns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheritingObject.hashCode()
is incorrect.- Specified by:
hashCode
in interfaceMessage
- Overrides:
hashCode
in classAbstractMessage
- Returns:
- the hash code value for this message
- See Also:
-
parseFrom
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Method parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Method parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
InvalidProtocolBufferException
-
parseFrom
public static Method parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException - Throws:
InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Method parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Method parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Method parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
Description copied from interface:MessageLite
Constructs a new builder for a message of the same type as this message.- Specified by:
newBuilderForType
in interfaceMessage
- Specified by:
newBuilderForType
in interfaceMessageLite
-
newBuilder
-
newBuilder
-
toBuilder
Description copied from interface:MessageLite
Constructs a builder initialized with the current message. Use this to derive a new message from the current one.- Specified by:
toBuilder
in interfaceMessage
- Specified by:
toBuilder
in interfaceMessageLite
-
newBuilderForType
Description copied from class:GeneratedMessageV3
TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.- Specified by:
newBuilderForType
in classGeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
Description copied from interface:MessageLite
Gets the parser for a message of the same type as this message.- Specified by:
getParserForType
in interfaceMessage
- Specified by:
getParserForType
in interfaceMessageLite
- Overrides:
getParserForType
in classGeneratedMessageV3
-
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
-