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

public final class Method
extends GeneratedMessageV3
implements MethodOrBuilder

Method represents a method of an API interface.

Protobuf type google.protobuf.Method

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Method.Builder	Method represents a method of an API interface.

Nested classes/interfaces inherited from class GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType, BuilderType>, GeneratedMessageV3.ExtendableMessage<MessageType>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType>, GeneratedMessageV3.ExtensionDescriptorRetriever, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
private static final Method	DEFAULT_INSTANCE
private byte	memoizedIsInitialized
private Object	name_
static final int	NAME_FIELD_NUMBER
private List<Option>	options_
static final int	OPTIONS_FIELD_NUMBER
private static final Parser<Method>	PARSER
static final int	REQUEST_STREAMING_FIELD_NUMBER
static final int	REQUEST_TYPE_URL_FIELD_NUMBER
private boolean	requestStreaming_
private Object	requestTypeUrl_
static final int	RESPONSE_STREAMING_FIELD_NUMBER
static final int	RESPONSE_TYPE_URL_FIELD_NUMBER
private boolean	responseStreaming_
private Object	responseTypeUrl_
private static final long	serialVersionUID
private int	syntax_
static final int	SYNTAX_FIELD_NUMBER

Fields inherited from class GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class AbstractMessage

memoizedSize

Fields inherited from class AbstractMessageLite

memoizedHashCode

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Method()
private	Method(GeneratedMessageV3.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Compares the specified object with this message for equality.
static Method	getDefaultInstance()
Method	getDefaultInstanceForType()	Get an instance of the type with no fields set.
static final Descriptors.Descriptor	getDescriptor()
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.
int	getOptionsCount()	Any metadata attached to the method.
List<Option>	getOptionsList()	Any metadata attached to the method.
OptionOrBuilder	getOptionsOrBuilder(int index)	Any metadata attached to the method.
List<? extends OptionOrBuilder>	getOptionsOrBuilderList()	Any metadata attached to the method.
Parser<Method>	getParserForType()	Gets the parser for a message of the same type as this message.
boolean	getRequestStreaming()	If true, the request is streamed.
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.
String	getResponseTypeUrl()	The URL of the output message type.
ByteString	getResponseTypeUrlBytes()	The URL of the output message type.
int	getSerializedSize()	Get the number of bytes required to encode this message.
Syntax	getSyntax()	The source syntax of this method.
int	getSyntaxValue()	The source syntax of this method.
final UnknownFieldSet	getUnknownFields()	Get the UnknownFieldSet for this message.
int	hashCode()	Returns the hash code value for this message.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()	Get the FieldAccessorTable for this type.
final boolean	isInitialized()	Returns true if all required fields in the message and all embedded messages are set, false otherwise.
static Method.Builder	newBuilder()
static Method.Builder	newBuilder(Method prototype)
Method.Builder	newBuilderForType()	Constructs a new builder for a message of the same type as this message.
protected Method.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)	TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)	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)
static Parser<Method>	parser()
Method.Builder	toBuilder()	Constructs a builder initialized with the current message.
void	writeTo(CodedOutputStream output)	Serializes the message and writes it to output.

Methods inherited from class 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 AbstractMessage

compareFields, findInitializationErrors, getInitializationErrorString, getMemoizedSerializedSize, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, newUninitializedMessageException, setMemoizedSerializedSize, toString

Methods inherited from class AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, getSerializedSize, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

• Constant Field Values

name_

private volatile Object name_

REQUEST_TYPE_URL_FIELD_NUMBER

public static final int REQUEST_TYPE_URL_FIELD_NUMBER

See Also:

• Constant Field Values

requestTypeUrl_

private volatile Object requestTypeUrl_

REQUEST_STREAMING_FIELD_NUMBER

public static final int REQUEST_STREAMING_FIELD_NUMBER

See Also:

• Constant Field Values

requestStreaming_

private boolean requestStreaming_

RESPONSE_TYPE_URL_FIELD_NUMBER

public static final int RESPONSE_TYPE_URL_FIELD_NUMBER

See Also:

• Constant Field Values

responseTypeUrl_

private volatile Object responseTypeUrl_

RESPONSE_STREAMING_FIELD_NUMBER

public static final int RESPONSE_STREAMING_FIELD_NUMBER

See Also:

• Constant Field Values

responseStreaming_

private boolean responseStreaming_

OPTIONS_FIELD_NUMBER

public static final int OPTIONS_FIELD_NUMBER

See Also:

• Constant Field Values

options_

private List<Option> options_

SYNTAX_FIELD_NUMBER

public static final int SYNTAX_FIELD_NUMBER

See Also:

• Constant Field Values

syntax_

private int syntax_

memoizedIsInitialized

private byte memoizedIsInitialized

DEFAULT_INSTANCE

private static final Method DEFAULT_INSTANCE

PARSER

private static final Parser<Method> PARSER

Constructor Details

Method

private Method(GeneratedMessageV3.Builder<?> builder)

Method

private Method()

Method Details

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Description copied from class: GeneratedMessageV3

Creates a new instance of this message type. Overridden in the generated code.

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Description copied from interface: MessageOrBuilder

Get the UnknownFieldSet for this message.

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable 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 class GeneratedMessageV3

getName

public String getName()

The simple name of this method.

string name = 1;

Specified by:

getName in interface MethodOrBuilder

Returns:

The name.

getNameBytes

public ByteString getNameBytes()

The simple name of this method.

string name = 1;

Specified by:

getNameBytes in interface MethodOrBuilder

Returns:

The bytes for name.

getRequestTypeUrl

public String getRequestTypeUrl()

A URL of the input message type.

string request_type_url = 2;

Specified by:

getRequestTypeUrl in interface MethodOrBuilder

Returns:

The requestTypeUrl.

getRequestTypeUrlBytes

public ByteString getRequestTypeUrlBytes()

A URL of the input message type.

string request_type_url = 2;

Specified by:

getRequestTypeUrlBytes in interface MethodOrBuilder

Returns:

The bytes for requestTypeUrl.

getRequestStreaming

public boolean getRequestStreaming()

If true, the request is streamed.

bool request_streaming = 3;

Specified by:

getRequestStreaming in interface MethodOrBuilder

Returns:

The requestStreaming.

getResponseTypeUrl

public String getResponseTypeUrl()

The URL of the output message type.

string response_type_url = 4;

Specified by:

getResponseTypeUrl in interface MethodOrBuilder

Returns:

The responseTypeUrl.

getResponseTypeUrlBytes

public ByteString getResponseTypeUrlBytes()

The URL of the output message type.

string response_type_url = 4;

Specified by:

getResponseTypeUrlBytes in interface MethodOrBuilder

Returns:

The bytes for responseTypeUrl.

getResponseStreaming

public boolean getResponseStreaming()

If true, the response is streamed.

bool response_streaming = 5;

Specified by:

getResponseStreaming in interface MethodOrBuilder

Returns:

The responseStreaming.

getOptionsList

public List<Option> getOptionsList()

Any metadata attached to the method.

repeated .google.protobuf.Option options = 6;

Specified by:

getOptionsList in interface MethodOrBuilder

getOptionsOrBuilderList

public List<? extends OptionOrBuilder> getOptionsOrBuilderList()

Any metadata attached to the method.

repeated .google.protobuf.Option options = 6;

Specified by:

getOptionsOrBuilderList in interface MethodOrBuilder

getOptionsCount

public int getOptionsCount()

Any metadata attached to the method.

repeated .google.protobuf.Option options = 6;

Specified by:

getOptionsCount in interface MethodOrBuilder

getOptions

public Option getOptions(int index)

Any metadata attached to the method.

repeated .google.protobuf.Option options = 6;

Specified by:

getOptions in interface MethodOrBuilder

getOptionsOrBuilder

public OptionOrBuilder getOptionsOrBuilder(int index)

Any metadata attached to the method.

repeated .google.protobuf.Option options = 6;

Specified by:

getOptionsOrBuilder in interface MethodOrBuilder

getSyntaxValue

public int getSyntaxValue()

The source syntax of this method.

.google.protobuf.Syntax syntax = 7;

Specified by:

getSyntaxValue in interface MethodOrBuilder

Returns:

The enum numeric value on the wire for syntax.

getSyntax

public Syntax getSyntax()

The source syntax of this method.

.google.protobuf.Syntax syntax = 7;

Specified by:

getSyntax in interface MethodOrBuilder

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.

See also: MessageOrBuilder.getInitializationErrorString()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Description copied from interface: MessageLite

Serializes the message and writes it to output. This does not flush or close the stream.

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

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 interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Description copied from interface: Message

Compares the specified object with this message for equality. Returns true if the given object is a message of the same type (as defined by getDescriptorForType()) and has identical values for all of its fields. Subclasses must implement this; inheriting Object.equals() is incorrect.

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

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; inheriting Object.hashCode() is incorrect.

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

Returns:

the hash code value for this message

See Also:

• Map.hashCode()

parseFrom

public static Method parseFrom(ByteBuffer data)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Method parseFrom(ByteBuffer data,
 ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Method parseFrom(ByteString data)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Method parseFrom(ByteString data,
 ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Method parseFrom(byte[] data)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Method parseFrom(byte[] data,
 ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Method parseFrom(InputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Method parseFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static Method parseDelimitedFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static Method parseDelimitedFrom(InputStream input,
 ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseFrom

public static Method parseFrom(CodedInputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Method parseFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

newBuilderForType

public Method.Builder newBuilderForType()

Description copied from interface: MessageLite

Constructs a new builder for a message of the same type as this message.

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Method.Builder newBuilder()

newBuilder

public static Method.Builder newBuilder(Method prototype)

toBuilder

public Method.Builder 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 interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Method.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Description copied from class: GeneratedMessageV3

TODO(xiaofeng): remove this together with GeneratedMessageV3.BuilderParent.

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Method getDefaultInstance()

parser

public static Parser<Method> parser()

getParserForType

public Parser<Method> getParserForType()

Description copied from interface: MessageLite

Gets the parser for a message of the same type as this message.

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

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 the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder